Связаться с намиПодключиться

Serverless Containers Service, gRPC: ContainerService.Update

Статья создана
Обновлена 17 декабря 2024 г.

Updates the specified container.

gRPC request

rpc Update (UpdateContainerRequest) returns (operation.Operation)

UpdateContainerRequest

{
  "container_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>"
}

Field

Description

container_id

string

Required field. ID of the container to update.

To get a container ID make a ContainerService.List request.

update_mask

google.protobuf.FieldMask

Field mask that specifies which attributes of the container should be updated.

name

string

New name for the container.
The name must be unique within the folder.

description

string

New description for the container.

labels

object (map<string, string>)

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.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "container_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "url": "string",
    "status": "Status"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateContainerMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Container

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateContainerMetadata

Field

Description

container_id

string

ID of the container that is being updated.

Container

Field

Description

id

string

ID of the container. Generated at creation time.

folder_id

string

ID of the folder that the container belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp for the container.

name

string

Name of the container. The name is unique within the folder.

description

string

Description of the container.

labels

object (map<string, string>)

Container labels as key:value pairs.

url

string

URL that needs to be requested to call the container.

status

enum Status

Status of the container.

  • STATUS_UNSPECIFIED
  • CREATING: Container is being created.
  • ACTIVE: Container is ready for use.
  • DELETING: Container is being deleted.
  • ERROR: Container failed. The only allowed action is delete.
Предыдущая
Create
Следующая
Delete