Update
Updates the specified filesystem.
- TypeScript
- Python
import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";
const Filesystem = cloudApi.compute.filesystem.Filesystem;
const UpdateFilesystemRequest =
cloudApi.compute.filesystem_service.UpdateFilesystemRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.FilesystemServiceClient);
const operation = await client.update(
UpdateFilesystemRequest.fromPartial({
filesystemId: "filesystemId",
// updateMask: {
// paths: ["paths"]
// },
// name: "name",
// description: "description",
// labels: {"key": "labels"},
// size: 0
})
);
const finishedOp = await waitForOperation(operation, session);
if (finishedOp.response) {
const result = decodeMessage<typeof Filesystem>(finishedOp.response);
console.log(result);
}
})();
import os
import grpc
import yandexcloud
from yandex.cloud.compute.v1.filesystem_pb2 import Filesystem
from yandex.cloud.compute.v1.filesystem_service_pb2_grpc import FilesystemServiceStub
from yandex.cloud.compute.v1.filesystem_service_pb2 import UpdateFilesystemMetadata
from yandex.cloud.compute.v1.filesystem_service_pb2 import UpdateFilesystemRequest
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(FilesystemServiceStub)
operation = service.Update(
UpdateFilesystemRequest(
filesystem_id="filesystemId",
# update_mask = FieldMask.FromJsonString("field1,field2"),
# name = "name",
# description = "description",
# labels = {"key": "labels"},
# size = 0
)
)
operation_result = sdk.wait_operation_and_get_result(
operation,
response_type=Filesystem,
meta_type=UpdateFilesystemMetadata,
)
print(operation_result)
UpdateFilesystemRequest
filesystemId
: string
ID of the filesystem to update.
To get the filesystem ID, make a FilesystemService.List request.
updateMask
: google.protobuf.FieldMask
Field mask that specifies which attributes of the filesystem should be updated.
name
: string
New name of the filesystem. The name must be unique within the folder.
description
: string
New description of the filesystem.
labels
: string
New filesystem labels as key:value
pairs.
For details about the concept, see documentation.
Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label:
- Get the current set of labels with a FilesystemService.Get request.
- Add or remove a label in this set.
- Send the new set in this field.
size
: int64
Size of the filesystem, specified in bytes.
Operation
An Operation resource. For more information, see Operation.
id
: string
ID of the operation.
description
: string
Description of the operation. 0-256 characters long.
createdAt
: google.protobuf.Timestamp
Creation timestamp.
createdBy
: string
ID of the user or service account who initiated the operation.
modifiedAt
: 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
: google.protobuf.Any
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.
One of result
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.
error
: google.rpc.StatusThe error result of the operation in case of failure or cancellation.
response
: google.protobuf.AnyThe 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.