Update

Updates the specified broker.

TypeScript

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

const Broker = cloudApi.iot.broker_broker.Broker;
const LogLevel_Level = cloudApi.logging.log_entry.LogLevel_Level;
const UpdateBrokerRequest =
  cloudApi.iot.broker_broker_service.UpdateBrokerRequest;

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

  const operation = await client.update(
    UpdateBrokerRequest.fromPartial({
      brokerId: "brokerId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // logOptions: {
      // disabled: true,
      // logGroupId: "logGroupId",
      // folderId: "folderId",
      // minLevel: LogLevel_Level.TRACE
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.iot.broker.v1.broker_pb2 import Broker
from yandex.cloud.iot.broker.v1.broker_service_pb2_grpc import BrokerServiceStub
from yandex.cloud.iot.broker.v1.broker_pb2 import LogOptions
from yandex.cloud.iot.broker.v1.broker_service_pb2 import UpdateBrokerMetadata
from yandex.cloud.iot.broker.v1.broker_service_pb2 import UpdateBrokerRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(BrokerServiceStub)
operation = service.Update(
    UpdateBrokerRequest(
        broker_id="brokerId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # log_options = LogOptions(
        # disabled = true,
        # log_group_id = "logGroupId",
        # folder_id = "folderId",
        # min_level = LogLevel.Level.TRACE
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Broker,
    meta_type=UpdateBrokerMetadata,
)
print(operation_result)

UpdateBrokerRequest

brokerId : string

ID of the broker to update.

To get a broker ID make a BrokerService.List request.

updateMask : google.protobuf.FieldMask

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

name : string

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

description : string

Description of the broker.

labels : string

Resource labels as key:value pairs.

Existing set of labels is completely replaced by the provided set.

logOptions : LogOptions

Options for logging broker events

LogOptions

disabled : bool

Is logging from broker disabled.

One of destination

Log entries destination.

• logGroupId : string

  Entry should be written to log group resolved by ID.

• folderId : string

  Entry should be written to default log group for specified folder.

minLevel : yandex.cloud.logging.v1.LogLevel.Level

Minimum log entry level.

See LogLevel.Level for details.

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.

---