Resource Manager API, gRPC: FolderService.Update

Статья создана

Yandex Cloud

Обновлена 17 декабря 2024 г.

gRPC request
UpdateFolderRequest
operation.Operation
UpdateFolderMetadata
Folder

Updates the specified folder.

gRPC request

rpc Update (UpdateFolderRequest) returns (operation.Operation)

UpdateFolderRequest

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

Field	Description
folder_id	string Required field. ID of the Folder resource to update. To get the folder ID, use a FolderService.List request.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the Folder resource are going to be updated.
name	string Required field. Name of the folder. The name must be unique within the cloud.
description	string Description of the folder.
labels	object (map<string, string>) Resource labels as `key:value` pairs.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "folder_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "cloud_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, 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	UpdateFolderMetadata 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	Folder 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.

UpdateFolderMetadata

Field

Description

folder_id

string

ID of the Folder resource that is being updated.

Folder

A Folder resource. For more information, see Folder.

Field	Description
id	string ID of the folder.
cloud_id	string ID of the cloud that the folder belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the folder. The name is unique within the cloud. 3-63 characters long.
description	string Description of the folder. 0-256 characters long.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Maximum of 64 per resource.
status	enum Status Status of the folder. `STATUS_UNSPECIFIED` `ACTIVE`: The folder is active. `DELETING`: The folder is being deleted. `PENDING_DELETION`: Stopping folder resources and waiting for the deletion start timestamp.