Update

Updates the specified subnet. Method starts an asynchronous operation that can be cancelled while it is in progress.

TypeScript

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

const Subnet = cloudApi.vpc.subnet.Subnet;
const UpdateSubnetRequest = cloudApi.vpc.subnet_service.UpdateSubnetRequest;

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

  const operation = await client.update(
    UpdateSubnetRequest.fromPartial({
      subnetId: "subnetId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // routeTableId: "routeTableId",
      // dhcpOptions: {
      // domainNameServers: ["domainNameServers"],
      // domainName: "domainName",
      // ntpServers: ["ntpServers"]
      // },
      // v4CidrBlocks: ["v4CidrBlocks"]
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.vpc.v1.subnet_pb2 import DhcpOptions
from yandex.cloud.vpc.v1.subnet_pb2 import Subnet
from yandex.cloud.vpc.v1.subnet_service_pb2_grpc import SubnetServiceStub
from yandex.cloud.vpc.v1.subnet_service_pb2 import UpdateSubnetMetadata
from yandex.cloud.vpc.v1.subnet_service_pb2 import UpdateSubnetRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(SubnetServiceStub)
operation = service.Update(
    UpdateSubnetRequest(
        subnet_id="subnetId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # route_table_id = "routeTableId",
        # dhcp_options = DhcpOptions(
        # domain_name_servers = ["domainNameServers"],
        # domain_name = "domainName",
        # ntp_servers = ["ntpServers"]
        # ),
        # v_4_cidr_blocks = ["v4CidrBlocks"]
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Subnet,
    meta_type=UpdateSubnetMetadata,
)
print(operation_result)

UpdateSubnetRequest

subnetId : string

ID of the Subnet resource to update.

updateMask : google.protobuf.FieldMask

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

name : string

Name of the subnet. The name must be unique within the folder.

description : string

Description of the subnet.

labels : string

Resource labels as key:value pairs.

routeTableId : string

ID of route table the subnet is linked to.

dhcpOptions : DhcpOptions

v4CidrBlocks : string

New CIDR blocks which will overwrite the existing ones.

DhcpOptions

domainNameServers : string

A list of DHCP servers for this subnet.

domainName : string

A domain name to us as a suffix when resolving host names in this subnet.

ntpServers : string

List of NTP servers for this subnet.

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.

---