IoT Core Broker Service, gRPC: BrokerService
A set of methods for managing broker.
Call | Description |
---|---|
Get | Returns the specified broker. |
List | Retrieves the list of brokers in the specified folder. |
Create | Creates a broker in the specified folder. |
Update | Updates the specified broker. |
Delete | Deletes the specified broker. |
ListCertificates | Retrieves the list of broker certificates for the specified broker. |
AddCertificate | Adds a certificate. |
DeleteCertificate | Deletes the specified broker certificate. |
ListPasswords | Retrieves the list of passwords for the specified broker. |
AddPassword | Adds password for the specified broker. |
DeletePassword | Deletes the specified password. |
ListOperations | Lists operations for the specified broker. |
Calls BrokerService
Get
Returns the specified broker.
To get the list of available brokers, make a List request.
rpc Get (GetBrokerRequest) returns (Broker)
GetBrokerRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to return. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50. |
Broker
Field | Description |
---|---|
id | string ID of the broker. |
folder_id | string ID of the folder that the broker belongs to. |
created_at | 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 | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the broker.
|
log_options | LogOptions Options for logging broker events |
LogOptions
Field | Description |
---|---|
disabled | bool Is logging from broker disabled. |
destination | oneof: log_group_id or folder_id Log entries destination. |
log_group_id | string Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
min_level | yandex.cloud.logging.v1.LogLevel.Level Minimum log entry level. See [LogLevel.Level] for details. |
List
Retrieves the list of brokers in the specified folder.
rpc List (ListBrokersRequest) returns (ListBrokersResponse)
ListBrokersRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list brokers in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
page_size | 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.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListBrokersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
ListBrokersResponse
Field | Description |
---|---|
brokers[] | Broker List of brokers. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListBrokersRequest.page_size, use next_page_token as the value for the ListBrokersRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
Broker
Field | Description |
---|---|
id | string ID of the broker. |
folder_id | string ID of the folder that the broker belongs to. |
created_at | 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 | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the broker.
|
log_options | LogOptions Options for logging broker events |
LogOptions
Field | Description |
---|---|
disabled | bool Is logging from broker disabled. |
destination | oneof: log_group_id or folder_id Log entries destination. |
log_group_id | string Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
min_level | yandex.cloud.logging.v1.LogLevel.Level Minimum log entry level. See [LogLevel.Level] for details. |
Create
Creates a broker in the specified folder.
rpc Create (CreateBrokerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateBrokerMetadata
Operation.response:Broker
CreateBrokerRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create a broker in. To get a folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
name | string Required. Name of the broker. The name must be unique within the folder. The maximum string length in characters is 50. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the broker. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
certificates[] | Certificate Broker certificates. |
password | string Broker passwords. The password must contain at least three character categories among the following: upper case latin, lower case latin, numbers and special symbols. |
log_options | LogOptions Options for logging broker events |
Certificate
Field | Description |
---|---|
certificate_data | string Public part of the broker certificate. |
LogOptions
Field | Description |
---|---|
disabled | bool Is logging from broker disabled. |
destination | oneof: log_group_id or folder_id Log entries destination. |
log_group_id | string Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
min_level | yandex.cloud.logging.v1.LogLevel.Level Minimum log entry level. See [LogLevel.Level] for details. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or response 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 if operation finished successfully. |
CreateBrokerMetadata
Field | Description |
---|---|
broker_id | string ID of the broker that is being created. |
Broker
Field | Description |
---|---|
id | string ID of the broker. |
folder_id | string ID of the folder that the broker belongs to. |
created_at | 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 | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the broker.
|
log_options | LogOptions Options for logging broker events |
Update
Updates the specified broker.
rpc Update (UpdateBrokerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateBrokerMetadata
Operation.response:Broker
UpdateBrokerRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to update. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50. |
update_mask | 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. The maximum string length in characters is 50. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the broker. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. Existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
log_options | LogOptions Options for logging broker events |
LogOptions
Field | Description |
---|---|
disabled | bool Is logging from broker disabled. |
destination | oneof: log_group_id or folder_id Log entries destination. |
log_group_id | string Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
min_level | yandex.cloud.logging.v1.LogLevel.Level Minimum log entry level. See [LogLevel.Level] for details. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or response 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 if operation finished successfully. |
UpdateBrokerMetadata
Field | Description |
---|---|
broker_id | string ID of the broker that is being updated. |
Broker
Field | Description |
---|---|
id | string ID of the broker. |
folder_id | string ID of the folder that the broker belongs to. |
created_at | 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 | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the broker.
|
log_options | LogOptions Options for logging broker events |
Delete
Deletes the specified broker.
rpc Delete (DeleteBrokerRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteBrokerMetadata
Operation.response:google.protobuf.Empty
DeleteBrokerRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to delete. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or response 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 if operation finished successfully. |
DeleteBrokerMetadata
Field | Description |
---|---|
broker_id | string ID of the broker that is being deleted. |
ListCertificates
Retrieves the list of broker certificates for the specified broker.
rpc ListCertificates (ListBrokerCertificatesRequest) returns (ListBrokerCertificatesResponse)
ListBrokerCertificatesRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to list certificates for. The maximum string length in characters is 50. |
ListBrokerCertificatesResponse
Field | Description |
---|---|
certificates[] | BrokerCertificate List of certificates for the specified broker. |
BrokerCertificate
Field | Description |
---|---|
broker_id | string ID of the broker that the certificate belongs to. |
fingerprint | string SHA256 hash of the certificates. |
certificate_data | string Public part of the certificate. |
created_at | google.protobuf.Timestamp Creation timestamp. |
AddCertificate
Adds a certificate.
rpc AddCertificate (AddBrokerCertificateRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddBrokerCertificateMetadata
Operation.response:BrokerCertificate
AddBrokerCertificateRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker for which the certificate is being added. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50. |
certificate_data | string Public part of the certificate that is being added. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or response 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 if operation finished successfully. |
AddBrokerCertificateMetadata
Field | Description |
---|---|
broker_id | string ID of the broker certificate that is being added. |
fingerprint | string Fingerprint of the certificate that is being added. |
BrokerCertificate
Field | Description |
---|---|
broker_id | string ID of the broker that the certificate belongs to. |
fingerprint | string SHA256 hash of the certificates. |
certificate_data | string Public part of the certificate. |
created_at | google.protobuf.Timestamp Creation timestamp. |
DeleteCertificate
Deletes the specified broker certificate.
rpc DeleteCertificate (DeleteBrokerCertificateRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteBrokerCertificateMetadata
Operation.response:google.protobuf.Empty
DeleteBrokerCertificateRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to delete a certificate for. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50. |
fingerprint | string Required. Fingerprint of the certificate that is being deleted. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or response 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 if operation finished successfully. |
DeleteBrokerCertificateMetadata
Field | Description |
---|---|
broker_id | string Required. ID of a broker for which the certificate is being delete. The maximum string length in characters is 50. |
fingerprint | string Required. Fingerprint of the certificate to deleted. The maximum string length in characters is 50. |
ListPasswords
Retrieves the list of passwords for the specified broker.
rpc ListPasswords (ListBrokerPasswordsRequest) returns (ListBrokerPasswordsResponse)
ListBrokerPasswordsRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to list passwords in. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50. |
ListBrokerPasswordsResponse
Field | Description |
---|---|
passwords[] | BrokerPassword List of passwords for the specified broker. |
BrokerPassword
Field | Description |
---|---|
broker_id | string ID of the broker that the password belongs to. |
id | string ID of the password. |
created_at | google.protobuf.Timestamp Creation timestamp. |
AddPassword
Adds password for the specified broker.
rpc AddPassword (AddBrokerPasswordRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddBrokerPasswordMetadata
Operation.response:BrokerPassword
AddBrokerPasswordRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to add a password for. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50. |
password | string Passwords for the broker. The password must contain at least three character categories among the following: upper case latin, lower case latin, numbers and special symbols. The minimum string length in characters is 14. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or response 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 if operation finished successfully. |
AddBrokerPasswordMetadata
Field | Description |
---|---|
broker_id | string ID of the broker for which the password is being added. |
password_id | string ID of a password that is being added. |
BrokerPassword
Field | Description |
---|---|
broker_id | string ID of the broker that the password belongs to. |
id | string ID of the password. |
created_at | google.protobuf.Timestamp Creation timestamp. |
DeletePassword
Deletes the specified password.
rpc DeletePassword (DeleteBrokerPasswordRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteBrokerPasswordMetadata
Operation.response:google.protobuf.Empty
DeleteBrokerPasswordRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to delete a password for. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50. |
password_id | string Required. ID of the password to delete. To get a password ID make a BrokerService.ListPasswords request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or response 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 if operation finished successfully. |
DeleteBrokerPasswordMetadata
Field | Description |
---|---|
broker_id | string Required. ID of a broker for which the password is being delete. The maximum string length in characters is 50. |
password_id | string Required. ID of the password to delete. To get a password ID make a BrokerService.ListPasswords request. The maximum string length in characters is 50. |
ListOperations
Lists operations for the specified broker.
rpc ListOperations (ListBrokerOperationsRequest) returns (ListBrokerOperationsResponse)
ListBrokerOperationsRequest
Field | Description |
---|---|
broker_id | string Required. ID of the broker to list operations for. |
page_size | 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. Acceptable values are 0 to 1000, inclusive. |
page_token | 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. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. Currently you can use filtering only on Broker.name field. The maximum string length in characters is 1000. |
ListBrokerOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations for the specified broker. |
next_page_token | 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
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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. |
result | oneof: error or response 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 |