Contact UsGet started
© 2024 Iron Hive LLC Belgrade

IoT Core Broker Service, gRPC: BrokerService.List

Written by
Updated at October 17, 2024

Retrieves the list of brokers in the specified folder.

gRPC request

rpc List (ListBrokersRequest) returns (ListBrokersResponse)

ListBrokersRequest

{
  "folderId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

folderId

string

Required field. ID of the folder to list brokers in.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

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 ListBrokersResponse.nextPageToken
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
ListBrokersResponse.nextPageToken returned by a previous list request.

ListBrokersResponse

{
  "brokers": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "string",
      "status": "Status",
      "logOptions": {
        "disabled": "bool",
        // Includes only one of the fields `logGroupId`, `folderId`
        "logGroupId": "string",
        "folderId": "string",
        // end of the list of possible fields
        "minLevel": "Level"
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

brokers[]

Broker

List of brokers.

nextPageToken

string

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

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

Broker

A broker.

Field

Description

id

string

ID of the broker.

folderId

string

ID of the folder that the broker belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the broker. The name is unique within the folder.

description

string

Description of the broker. 0-256 characters long.

labels

string

Resource labels as key:value pairs. Maximum of 64 per resource.

status

enum Status

Status of the broker.

  • STATUS_UNSPECIFIED
  • CREATING: Broker is being created.
  • ACTIVE: Broker is ready to use.
  • DELETING: Broker is being deleted.

logOptions

LogOptions

Options for logging broker events

LogOptions

Field

Description

disabled

bool

Is logging from broker disabled.

logGroupId

string

Entry should be written to log group resolved by ID.

Includes only one of the fields logGroupId, folderId.

Log entries destination.

folderId

string

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

Includes only one of the fields logGroupId, folderId.

Log entries destination.

minLevel

enum Level

Minimum log entry level.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.
Previous
Get
Next
Create