Update
Updates the specified placement group.
- TypeScript
- Python
import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";
const PlacementGroup = cloudApi.compute.placement_group.PlacementGroup;
const UpdatePlacementGroupRequest =
cloudApi.compute.placement_group_service.UpdatePlacementGroupRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.PlacementGroupServiceClient);
const operation = await client.update(
UpdatePlacementGroupRequest.fromPartial({
// placementGroupId: "placementGroupId",
// updateMask: {
// paths: ["paths"]
// },
// name: "name",
// description: "description",
// labels: {"key": "labels"}
})
);
const finishedOp = await waitForOperation(operation, session);
if (finishedOp.response) {
const result = decodeMessage<typeof PlacementGroup>(finishedOp.response);
console.log(result);
}
})();
import os
import grpc
import yandexcloud
from yandex.cloud.compute.v1.placement_group_pb2 import PlacementGroup
from yandex.cloud.compute.v1.placement_group_service_pb2_grpc import PlacementGroupServiceStub
from yandex.cloud.compute.v1.placement_group_service_pb2 import UpdatePlacementGroupMetadata
from yandex.cloud.compute.v1.placement_group_service_pb2 import UpdatePlacementGroupRequest
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(PlacementGroupServiceStub)
operation = service.Update(
UpdatePlacementGroupRequest(
# placement_group_id = "placementGroupId",
# update_mask = FieldMask.FromJsonString("field1,field2"),
# name = "name",
# description = "description",
# labels = {"key": "labels"}
)
)
operation_result = sdk.wait_operation_and_get_result(
operation,
response_type=PlacementGroup,
meta_type=UpdatePlacementGroupMetadata,
)
print(operation_result)
UpdatePlacementGroupRequest
placementGroupId
: string
ID of the placement group to update.
To get the placement group ID, use an PlacementGroupService.List request.
updateMask
: google.protobuf.FieldMask
Field mask that specifies which fields of the PlacementGroup resource should be updated.
name
: string
Name of the placement group.
description
: string
Description of the placement group.
labels
: string
Resource labels as key:value
pairs.
The existing set of labels
is completely replaced by the provided set.
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.