Package-level declarations

Types

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard
data class DeviceConfigResponse(val binaryData: String, val cloudUpdateTime: String, val deviceAckTime: String, val version: String)

The device configuration. Eventually delivered to devices.

Link copied to clipboard
data class DeviceCredentialResponse(val expirationTime: String, val publicKey: PublicKeyCredentialResponse)

A server-stored device credential used for authentication.

Link copied to clipboard
data class DeviceStateResponse(val binaryData: String, val updateTime: String)

The device state, as reported by the device.

Link copied to clipboard
data class EventNotificationConfigResponse(val pubsubTopicName: String, val subfolderMatches: String)

The configuration for forwarding telemetry events.

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

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.

Link copied to clipboard
data class GatewayConfigResponse(val gatewayAuthMethod: String, val gatewayType: String, val lastAccessedGatewayId: String, val lastAccessedGatewayTime: String)

Gateway-related configuration and state.

Link copied to clipboard
data class GetDeviceResult(val blocked: Boolean, val config: DeviceConfigResponse, val credentials: List<DeviceCredentialResponse>, val gatewayConfig: GatewayConfigResponse, val lastConfigAckTime: String, val lastConfigSendTime: String, val lastErrorStatus: StatusResponse, val lastErrorTime: String, val lastEventTime: String, val lastHeartbeatTime: String, val lastStateTime: String, val logLevel: String, val metadata: Map<String, String>, val name: String, val numId: String, val state: DeviceStateResponse)
Link copied to clipboard
data class GetRegistryGroupIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetRegistryIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetRegistryResult(val credentials: List<RegistryCredentialResponse>, val eventNotificationConfigs: List<EventNotificationConfigResponse>, val httpConfig: HttpConfigResponse, val logLevel: String, val mqttConfig: MqttConfigResponse, val name: String, val stateNotificationConfig: StateNotificationConfigResponse)
Link copied to clipboard
data class HttpConfigResponse(val httpEnabledState: String)

The configuration of the HTTP bridge for a device registry.

Link copied to clipboard
data class MqttConfigResponse(val mqttEnabledState: String)

The configuration of MQTT for a device registry.

Link copied to clipboard
data class PublicKeyCertificateResponse(val certificate: String, val format: String, val x509Details: X509CertificateDetailsResponse)

A public key certificate format and data.

Link copied to clipboard
data class PublicKeyCredentialResponse(val format: String, val key: String)

A public key format and data.

Link copied to clipboard
data class RegistryCredentialResponse(val publicKeyCertificate: PublicKeyCertificateResponse)

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

Link copied to clipboard
data class StateNotificationConfigResponse(val pubsubTopicName: String)

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

Link copied to clipboard
data class StatusResponse(val code: Int, val details: List<Map<String, String>>, val message: String)

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.

Link copied to clipboard
data class X509CertificateDetailsResponse(val expiryTime: String, val issuer: String, val publicKeyType: String, val signatureAlgorithm: String, val startTime: String, val subject: String)

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