Update
Updates the specified bus.
- TypeScript
- Python
import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";
const Bus = cloudApi.serverless.eventrouter_bus.Bus;
const UpdateBusRequest =
cloudApi.serverless.eventrouter_bus_service.UpdateBusRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.BusServiceClient);
const operation = await client.update(
UpdateBusRequest.fromPartial({
busId: "busId",
// updateMask: {
// paths: ["paths"]
// },
// name: "name",
// description: "description",
// labels: {"key": "labels"},
// deletionProtection: true
})
);
const finishedOp = await waitForOperation(operation, session);
if (finishedOp.response) {
const result = decodeMessage<typeof Bus>(finishedOp.response);
console.log(result);
}
})();
import os
import grpc
import yandexcloud
from yandex.cloud.serverless.eventrouter.v1.bus_pb2 import Bus
from yandex.cloud.serverless.eventrouter.v1.bus_service_pb2_grpc import BusServiceStub
from yandex.cloud.serverless.eventrouter.v1.bus_service_pb2 import UpdateBusMetadata
from yandex.cloud.serverless.eventrouter.v1.bus_service_pb2 import UpdateBusRequest
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(BusServiceStub)
operation = service.Update(
UpdateBusRequest(
bus_id="busId",
# update_mask = FieldMask.FromJsonString("field1,field2"),
# name = "name",
# description = "description",
# labels = {"key": "labels"},
# deletion_protection = true
)
)
operation_result = sdk.wait_operation_and_get_result(
operation,
response_type=Bus,
meta_type=UpdateBusMetadata,
)
print(operation_result)
UpdateBusRequest
busId
: string
ID of the bus to update.
updateMask
: google.protobuf.FieldMask
Field mask that specifies which fields of the bus are going to be updated.
name
: string
New name of the bus.
description
: string
New description of the bus.
labels
: string
New labels of the bus.
deletionProtection
: bool
New flag that disallow deletion of the bus.
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.