Update

Updates the specified host group.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const HostGroup = cloudApi.compute.host_group.HostGroup;
const MaintenancePolicy = cloudApi.compute.maintenance.MaintenancePolicy;
const UpdateHostGroupRequest =
  cloudApi.compute.host_group_service.UpdateHostGroupRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.HostGroupServiceClient);

  const operation = await client.update(
    UpdateHostGroupRequest.fromPartial({
      hostGroupId: "hostGroupId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // maintenancePolicy: MaintenancePolicy.RESTART,
      // scalePolicy: {
      // fixedScale: {
      // size: 0
      // }
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof HostGroup>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.compute.v1.host_group_pb2 import HostGroup
from yandex.cloud.compute.v1.host_group_service_pb2_grpc import HostGroupServiceStub
from yandex.cloud.compute.v1.maintenance_pb2 import MaintenancePolicy
from yandex.cloud.compute.v1.host_group_pb2 import ScalePolicy
from yandex.cloud.compute.v1.host_group_service_pb2 import UpdateHostGroupMetadata
from yandex.cloud.compute.v1.host_group_service_pb2 import UpdateHostGroupRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(HostGroupServiceStub)
operation = service.Update(
    UpdateHostGroupRequest(
        host_group_id="hostGroupId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # maintenance_policy = MaintenancePolicy.RESTART,
        # scale_policy = ScalePolicy(
        # fixed_scale = ScalePolicy.FixedScale(
        # size = 0
        # )
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=HostGroup,
    meta_type=UpdateHostGroupMetadata,
)
print(operation_result)

UpdateHostGroupRequest

hostGroupId : string

ID of the host group to update. To get the host group ID, use an HostGroupService.List request.

updateMask : google.protobuf.FieldMask

Field mask that specifies which fields of the HostGroup resource are going to be updated.

name : string

Name of the group.

description : string

Description of the group.

labels : string

Resource labels as key:value pairs.

The existing set of labels is completely replaced by the provided set.

maintenancePolicy : MaintenancePolicy

Behaviour on maintenance events

scalePolicy : ScalePolicy

Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

FixedScale

size : int64

One of scaleType

• fixedScale : FixedScale

FixedScale

size : int64

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.Status

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

• response : google.protobuf.Any

  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.

---