googleapis.cloudiot.v1 library

Classes

BindDeviceToGatewayRequest

Request for BindDeviceToGateway.

BindDeviceToGatewayResponse

Response for BindDeviceToGateway.

Binding

Associates members with a role.

CloudiotApi

Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.

Device

The device resource.

DeviceConfig

The device configuration. Eventually delivered to devices.

DeviceCredential

A server-stored device credential used for authentication.

DeviceRegistry

A container for a group of devices.

DeviceState

The device state, as reported by the device.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

EventNotificationConfig

The configuration for forwarding telemetry events.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

GatewayConfig

Gateway-related configuration and state.

GetIamPolicyRequest

Request message for GetIamPolicy method.

GetPolicyOptions

Encapsulates settings provided to GetIamPolicy.

HttpConfig

The configuration of the HTTP bridge for a device registry.

ListDeviceConfigVersionsResponse

Response for ListDeviceConfigVersions.

ListDeviceRegistriesResponse

Response for ListDeviceRegistries.

ListDevicesResponse

Response for ListDevices.

ListDeviceStatesResponse

Response for ListDeviceStates.

ModifyCloudToDeviceConfigRequest

Request for ModifyCloudToDeviceConfig.

MqttConfig

The configuration of MQTT for a device registry.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" }, { "role": "roles/resourcemanager.organizationViewer", "members": "user:[e-mail]" , "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:[e-mail] - group:[e-mail] - domain:google.com - serviceAccount:[e-mail] role: roles/resourcemanager.organizationAdmin - members: - user:[e-mail] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.

ProjectsLocationsRegistriesDevicesConfigVersionsResourceApi

ProjectsLocationsRegistriesDevicesResourceApi

ProjectsLocationsRegistriesDevicesStatesResourceApi

ProjectsLocationsRegistriesGroupsDevicesResourceApi

ProjectsLocationsRegistriesGroupsResourceApi

ProjectsLocationsRegistriesResourceApi

ProjectsLocationsResourceApi

ProjectsResourceApi

PublicKeyCertificate

A public key certificate format and data.

PublicKeyCredential

A public key format and data.

RegistryCredential

A server-stored registry credential used to validate device credentials.

SendCommandToDeviceRequest

Request for SendCommandToDevice.

SendCommandToDeviceResponse

Response for SendCommandToDevice.

SetIamPolicyRequest

Request message for SetIamPolicy method.

StateNotificationConfig

The configuration for notification of new states received from the device.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

UnbindDeviceFromGatewayRequest

Request for UnbindDeviceFromGateway.

UnbindDeviceFromGatewayResponse

Response for UnbindDeviceFromGateway.

X509CertificateDetails

Details of an X.509 certificate. For informational purposes only.

Constants

USER_AGENT → const String

'dart-api-client cloudiot/v1'

Exceptions / Errors

ApiRequestError

Represents a general error reported by the API endpoint.

DetailedApiRequestError

Represents a specific error reported by the API endpoint.