path: root/contrib/libs/yandex-cloud-api-protos/yandex/cloud/serverless/containers/v1/container_service.proto

syntax = "proto3";

package yandex.cloud.serverless.containers.v1;

import "google/api/annotations.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/field_mask.proto";
import "yandex/cloud/access/access.proto";
import "yandex/cloud/api/operation.proto";
import "yandex/cloud/operation/operation.proto";
import "yandex/cloud/serverless/containers/v1/container.proto";
import "yandex/cloud/validation.proto";

option go_package = "github.com/yandex-cloud/go-genproto/yandex/cloud/serverless/containers/v1;containers";
option java_package = "yandex.cloud.api.serverless.containers.v1";

// A set of methods for managing serverless containers.
service ContainerService {
  // Returns the specified container.
  //
  // To get the list of all available containers, make a [List] request.
  rpc Get(GetContainerRequest) returns (Container) {
    option (google.api.http) = {get: "/containers/v1/containers/{container_id}"};
  }

  // Retrieves the list of containers in the specified folder.
  rpc List(ListContainersRequest) returns (ListContainersResponse) {
    option (google.api.http) = {get: "/containers/v1/containers"};
  }

  // Creates a container in the specified folder.
  rpc Create(CreateContainerRequest) returns (operation.Operation) {
    option (google.api.http) = {
      post: "/containers/v1/containers"
      body: "*"
    };
    option (yandex.cloud.api.operation) = {
      metadata: "CreateContainerMetadata"
      response: "Container"
    };
  }

  // Updates the specified container.
  rpc Update(UpdateContainerRequest) returns (operation.Operation) {
    option (google.api.http) = {
      patch: "/containers/v1/containers/{container_id}"
      body: "*"
    };
    option (yandex.cloud.api.operation) = {
      metadata: "UpdateContainerMetadata"
      response: "Container"
    };
  }

  // Deletes the specified container.
  rpc Delete(DeleteContainerRequest) returns (operation.Operation) {
    option (google.api.http) = {delete: "/containers/v1/containers/{container_id}"};
    option (yandex.cloud.api.operation) = {
      metadata: "DeleteContainerMetadata"
      response: "google.protobuf.Empty"
    };
  }

  // Deploys a revision for the specified container.
  rpc DeployRevision(DeployContainerRevisionRequest) returns (operation.Operation) {
    option (google.api.http) = {
      post: "/containers/v1/revisions:deploy"
      body: "*"
    };
    option (yandex.cloud.api.operation) = {
      metadata: "DeployContainerRevisionMetadata"
      response: "Revision"
    };
  }

  // Rollback the specified container to an old revision.
  rpc Rollback(RollbackContainerRequest) returns (operation.Operation) {
    option (google.api.http) = {
      post: "/containers/v1/containers/{container_id}:rollback"
      body: "*"
    };
    option (yandex.cloud.api.operation) = {
      metadata: "RollbackContainerMetadata"
      response: "Container"
    };
  }

  // Returns the specified revision of a container.
  //
  // To get the list of available revision, make a [ListRevisions] request.
  rpc GetRevision(GetContainerRevisionRequest) returns (Revision) {
    option (google.api.http) = {get: "/containers/v1/revisions/{container_revision_id}"};
  }

  // Retrieves the list of revisions for the specified container, or of all container revisions
  // in the specified folder.
  rpc ListRevisions(ListContainersRevisionsRequest) returns (ListContainersRevisionsResponse) {
    option (google.api.http) = {get: "/containers/v1/revisions"};
  }

  // Lists operations for the specified container.
  rpc ListOperations(ListContainerOperationsRequest) returns (ListContainerOperationsResponse) {
    option (google.api.http) = {get: "/containers/v1/containers/{container_id}/operations"};
  }

  // Lists existing access bindings for the specified container.
  rpc ListAccessBindings(access.ListAccessBindingsRequest) returns (access.ListAccessBindingsResponse) {
    option (google.api.http) = {get: "/containers/v1/containers/{resource_id}:listAccessBindings"};
  }

  // Sets access bindings for the container.
  rpc SetAccessBindings(access.SetAccessBindingsRequest) returns (operation.Operation) {
    option (google.api.http) = {
      post: "/containers/v1/containers/{resource_id}:setAccessBindings"
      body: "*"
    };
    option (yandex.cloud.api.operation) = {
      metadata: "access.SetAccessBindingsMetadata"
      response: "google.protobuf.Empty"
    };
  }

  // Updates access bindings for the specified container.
  rpc UpdateAccessBindings(access.UpdateAccessBindingsRequest) returns (operation.Operation) {
    option (google.api.http) = {
      post: "/containers/v1/containers/{resource_id}:updateAccessBindings"
      body: "*"
    };
    option (yandex.cloud.api.operation) = {
      metadata: "access.UpdateAccessBindingsMetadata"
      response: "google.protobuf.Empty"
    };
  }
}

message GetContainerRequest {
  // ID of the container to return.
  //
  // To get a container ID make a [ContainerService.List] request.
  string container_id = 1 [(required) = true];
}

message ListContainersRequest {
  // ID of the folder to list containers in.
  //
  // To get a folder ID make a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
  string folder_id = 1 [(required) = true];

  // The maximum number of results per page to return. If the number of available
  // results is larger than `pageSize`, the service returns a [ListContainersResponse.next_page_token]
  // that can be used to get the next page of results in subsequent list requests.
  //
  // Default value: 100.
  int64 page_size = 2;

  // Page token. To get the next page of results, set `pageToken` to the
  // [ListContainersResponse.next_page_token] returned by a previous list request.
  string page_token = 3;

  // A filter expression that filters containers listed in the response.
  //
  // The expression must specify:
  // 1. The field name. Currently filtering can only be applied to the [Container.name] field.
  // 2. An `=` operator.
  // 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`.
  // Example of a filter: `name="my-container"`.
  string filter = 4;
}

message ListContainersResponse {
  // List of containers in the specified folder.
  repeated Container containers = 1;

  // Token for getting the next page of the list. If the number of results is greater than
  // the specified [ListContainersRequest.page_size], use `nextPageToken` as the value
  // for the [ListContainersRequest.page_token] parameter in the next list request.
  //
  // Each subsequent page will have its own `nextPageToken` to continue paging through the results.
  string next_page_token = 2;
}

message CreateContainerRequest {
  // ID of the folder to create a container in.
  //
  // To get a folder ID make a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
  string folder_id = 1 [(required) = true];

  // Name of the container.
  // The name must be unique within the folder.
  string name = 2 [(pattern) = "|[a-z][-a-z0-9]{1,61}[a-z0-9]"];

  // Description of the container.
  string description = 3 [(length) = "<=256"];

  // Resource labels as `key:value` pairs.
  map<string, string> labels = 4 [
    (size) = "<=64",
    (length) = "<=63",
    (pattern) = "[-_0-9a-z]*",
    (map_key).length = "1-63",
    (map_key).pattern = "[a-z][-_0-9a-z]*"
  ];
}

message CreateContainerMetadata {
  // ID of the container that is being created.
  string container_id = 1;
}

message UpdateContainerRequest {
  // ID of the container to update.
  //
  // To get a container ID make a [ContainerService.List] request.
  string container_id = 1 [(required) = true];

  // Field mask that specifies which attributes of the container should be updated.
  google.protobuf.FieldMask update_mask = 2;

  // New name for the container.
  // The name must be unique within the folder.
  string name = 3 [(pattern) = "|[a-z][-a-z0-9]{1,61}[a-z0-9]"];

  // New description for the container.
  string description = 4 [(length) = "<=256"];

  // Container labels as `key:value` pairs.
  //
  // Existing set of labels is completely replaced by the provided set, so if you just want
  // to add or remove a label, request the current set of labels with a [ContainerService.Get] request.
  map<string, string> labels = 5 [
    (size) = "<=64",
    (length) = "<=63",
    (pattern) = "[-_0-9a-z]*",
    (map_key).length = "1-63",
    (map_key).pattern = "[a-z][-_0-9a-z]*"
  ];
}

message UpdateContainerMetadata {
  // ID of the container that is being updated.
  string container_id = 1;
}

message DeleteContainerRequest {
  // ID of the container to delete.
  // To get a container ID make a [ContainerService.List] request.
  string container_id = 1 [(required) = true];
}

message DeleteContainerMetadata {
  // ID of the container that is being deleted.
  string container_id = 1;
}

message GetContainerRevisionRequest {
  // ID of the revision to return.
  //
  // To get a revision ID make a [ContainerService.ListRevisions] request.
  string container_revision_id = 1 [(required) = true];
}

message ListContainersRevisionsRequest {
  oneof id {
    option (exactly_one) = true;
    // ID of the folder to list container revisions for.
    // To get a folder ID make a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
    string folder_id = 1;

    // ID of the container to list revisions for.
    // To get a container ID use a [ContainerService.List] request.
    string container_id = 2;
  }

  // The maximum number of results per page to return. If the number of available results
  // is larger than `pageSize`, the service returns a [ListContainersRevisionsResponse.next_page_token]
  // that can be used to get the next page of results in subsequent list requests.
  //
  // Default value: 100.
  int64 page_size = 3 [(value) = "0-1000"];

  // Page token. To get the next page of results, set `pageToken` to the
  // [ListContainersRevisionsResponse.next_page_token] returned by a previous list request.
  string page_token = 4 [(length) = "<=100"];

  // A filter expression that filters resources listed in the response.
  //
  // The expression must specify:
  // 1. The field name. Currently filtering can only be applied to the [Revision.status] and [Revision.runtime] fields.
  // 2. An `=` operator.
  // 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`.
  // Example of a filter: `status="ACTIVE"`.
  string filter = 5 [(length) = "<=1000"];
}

message ListContainersRevisionsResponse {
  // List of revisions for the specified folder or container.
  repeated Revision revisions = 1;

  // Token for getting the next page of the list. If the number of results is greater than
  // the specified [ListContainersRevisionsRequest.page_size], use `nextPageToken` as the value
  // for the [ListContainersRevisionsRequest.page_token] parameter in the next list request.
  //
  // Each subsequent page will have its own `nextPageToken` to continue paging through the results.
  string next_page_token = 2;
}

message DeployContainerRevisionRequest {
  reserved 4;
  reserved 2;
  // ID of the container to create a revision for.
  //
  // To get a container ID, make a [ContainerService.List] request.
  string container_id = 1 [(required) = true];

  // Description of the revision.
  string description = 3;

  // Resources allocated to the revision.
  Resources resources = 5 [(required) = true];

  // Timeout for the execution of the revision.
  //
  // If the timeout is exceeded, Serverless Containers responds with a 504 HTTP code.
  google.protobuf.Duration execution_timeout = 6 [(value) = "<=600s"];

  // ID of the service account to associate with the revision.
  string service_account_id = 7;

  // Image configuration for the revision.
  ImageSpec image_spec = 8 [(required) = true];

  // The number of concurrent requests allowed per container instance.
  //
  // The default value is 1.
  int64 concurrency = 9;

  // Yandex Lockbox secrets to be used by the revision.
  repeated Secret secrets = 10;

  // Network access. If specified the revision will be attached to specified network/subnet(s).
  Connectivity connectivity = 11;

  // Policy for provisioning instances of the revision.
  //
  // The policy is only applied when the revision is ACTIVE.
  ProvisionPolicy provision_policy = 12;

  // Policy for scaling instances of the revision.
  ScalingPolicy scaling_policy = 13;

  // Options for logging from the container.
  LogOptions log_options = 14;

  // S3 mounts to be used by the version.
  repeated StorageMount storage_mounts = 15;
}

// Revision image specification.
message ImageSpec {
  // Image URL, that is used by the revision.
  string image_url = 1 [(required) = true];

  // Override for the image's ENTRYPOINT.
  Command command = 2;

  // Override for the image's CMD.
  Args args = 3;

  // Additional environment for the container.
  map<string, string> environment = 4 [
    (length) = "<=4096",
    (map_key).pattern = "[a-zA-Z][a-zA-Z0-9_]*"
  ];

  // Override for the image's WORKDIR.
  string working_dir = 5;
}

message DeployContainerRevisionMetadata {
  // ID of the revision that is being created.
  string container_revision_id = 1;
}

message RollbackContainerRequest {
  // ID of the container to rollback to an old revision.
  //
  // To get a container ID, make a [ContainerService.List] request.
  string container_id = 1 [(required) = true];

  // ID of the revision to rollback to.
  //
  // To get a revision ID make a [ContainerService.ListRevisions] request.
  string revision_id = 2 [(required) = true];
}

message RollbackContainerMetadata {
  // ID of the container that is being rolled back.
  string container_id = 1;

  // ID of the revision that the container is being rolled back to.
  string revision_id = 2;
}

message ListContainerOperationsRequest {
  // ID of the container to list operations for.
  string container_id = 1 [(required) = true];

  // The maximum number of results per page that should be returned. If the number of available
  // results is larger than `pageSize`, the service returns a [ListContainerOperationsResponse.next_page_token]
  // that can be used to get the next page of results in subsequent list requests.
  //
  // Default value: 100.
  int64 page_size = 2 [(value) = "0-1000"];

  // Page token. To get the next page of results, set `pageToken` to the
  // [ListContainerOperationsResponse.next_page_token] returned by a previous list request.
  string page_token = 3 [(length) = "<=100"];

  // A filter expression that filters resources listed in the response.
  //
  // The expression must specify:
  // 1. The field name. Currently filtering can be applied to the [operation.Operation.done], [operation.Operation.created_by] field.
  // 2. An `=` operator.
  // 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`.
  // Examples of a filter: `done=false`, `created_by='John.Doe'`.
  string filter = 4 [(length) = "<=1000"];
}

message ListContainerOperationsResponse {
  // List of operations for the specified container.
  repeated operation.Operation operations = 1;

  // Token for getting the next page of the list. If the number of results is greater than
  // the specified [ListContainerOperationsRequest.page_size], use `nextPageToken` as the value
  // for the [ListContainerOperationsRequest.page_token] parameter in the next list request.
  //
  // Each subsequent page will have its own `nextPageToken` to continue paging through the results.
  string next_page_token = 2;
}