Skip to main content

ListOperations

Lists operations for the specified broker.

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

const ListBrokerOperationsRequest =
  cloudApi.iot.broker_broker_service.ListBrokerOperationsRequest;

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

  const result = await client.listOperations(
    ListBrokerOperationsRequest.fromPartial({
      brokerId: "brokerId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

ListBrokerOperationsRequest​

brokerId : string​

ID of the broker to list operations for.

pageSize : int64​

The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListBrokerOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.

pageToken : string​

Page token. To get the next page of results, set page_token to the ListBrokerOperationsResponse.next_page_token returned by a previous list request.

filter : string​

A filter expression that filters resources listed in the response. Currently you can use filtering only on Broker.name field.

ListBrokerOperationsResponse​

operations : operation.Operation​

List of operations for the specified broker.

nextPageToken : string​

Token for getting the next page of the list. If the number of results is greater than the specified ListBrokerOperationsRequest.page_size, use next_page_token as the value for the ListBrokerOperationsRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

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.