Update
Updates the specified route table. Method starts an asynchronous operation that can be cancelled while it is in progress.
- TypeScript
- Python
import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";
const RouteTable = cloudApi.vpc.route_table.RouteTable;
const UpdateRouteTableRequest =
cloudApi.vpc.route_table_service.UpdateRouteTableRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.RouteTableServiceClient);
const operation = await client.update(
UpdateRouteTableRequest.fromPartial({
routeTableId: "routeTableId",
// updateMask: {
// paths: ["paths"]
// },
// name: "name",
// description: "description",
// labels: {"key": "labels"},
// staticRoutes: [{
// destinationPrefix: "destinationPrefix",
// nextHopAddress: "nextHopAddress",
// gatewayId: "gatewayId",
// labels: {"key": "labels"}
// }]
})
);
const finishedOp = await waitForOperation(operation, session);
if (finishedOp.response) {
const result = decodeMessage<typeof RouteTable>(finishedOp.response);
console.log(result);
}
})();
import os
import grpc
import yandexcloud
from yandex.cloud.vpc.v1.route_table_pb2 import RouteTable
from yandex.cloud.vpc.v1.route_table_service_pb2_grpc import RouteTableServiceStub
from yandex.cloud.vpc.v1.route_table_pb2 import StaticRoute
from yandex.cloud.vpc.v1.route_table_service_pb2 import UpdateRouteTableMetadata
from yandex.cloud.vpc.v1.route_table_service_pb2 import UpdateRouteTableRequest
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(RouteTableServiceStub)
operation = service.Update(
UpdateRouteTableRequest(
route_table_id="routeTableId",
# update_mask = FieldMask.FromJsonString("field1,field2"),
# name = "name",
# description = "description",
# labels = {"key": "labels"},
# static_routes = [StaticRoute(
# destination_prefix = "destinationPrefix",
# next_hop_address = "nextHopAddress",
# gateway_id = "gatewayId",
# labels = {"key": "labels"}
# )]
)
)
operation_result = sdk.wait_operation_and_get_result(
operation,
response_type=RouteTable,
meta_type=UpdateRouteTableMetadata,
)
print(operation_result)
UpdateRouteTableRequest
routeTableId
: string
ID of the RouteTable resource to update.
updateMask
: google.protobuf.FieldMask
Field mask that specifies which fields of the RouteTable resource are going to be updated.
name
: string
Name of the route table. The name must be unique within the folder.
description
: string
Description of the route table.
labels
: string
Resource labels as key:value
pairs.
staticRoutes
: StaticRoute
List of static routes.
StaticRoute
A StaticRoute resource. For more information, see Static Routes.
One of destination
destinationPrefix
: stringDestination subnet in CIDR notation
One of nextHop
labels
: string
Resource labels as key:value
pairs. Maximum of 64 per resource.
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.