iot

package
v0.0.0-...-2824937 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 2, 2020 License: MIT, Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package iot is a generated protocol buffer package.

It is generated from these files: 

google/cloud/iot/v1/device_manager.proto
google/cloud/iot/v1/resources.proto

It has these top-level messages: 

CreateDeviceRegistryRequest
GetDeviceRegistryRequest
DeleteDeviceRegistryRequest
UpdateDeviceRegistryRequest
ListDeviceRegistriesRequest
ListDeviceRegistriesResponse
CreateDeviceRequest
GetDeviceRequest
UpdateDeviceRequest
DeleteDeviceRequest
ListDevicesRequest
ListDevicesResponse
ModifyCloudToDeviceConfigRequest
ListDeviceConfigVersionsRequest
ListDeviceConfigVersionsResponse
ListDeviceStatesRequest
ListDeviceStatesResponse
Device
DeviceRegistry
MqttConfig
HttpConfig
EventNotificationConfig
StateNotificationConfig
RegistryCredential
X509CertificateDetails
PublicKeyCertificate
DeviceCredential
PublicKeyCredential
DeviceConfig
DeviceState

Index

Constants

This section is empty.

Variables

View Source 
var HttpState_name = map[int32]string{
	0: "HTTP_STATE_UNSPECIFIED",
	1: "HTTP_ENABLED",
	2: "HTTP_DISABLED",
}
View Source 
var HttpState_value = map[string]int32{
	"HTTP_STATE_UNSPECIFIED": 0,
	"HTTP_ENABLED":           1,
	"HTTP_DISABLED":          2,
}
View Source 
var MqttState_name = map[int32]string{
	0: "MQTT_STATE_UNSPECIFIED",
	1: "MQTT_ENABLED",
	2: "MQTT_DISABLED",
}
View Source 
var MqttState_value = map[string]int32{
	"MQTT_STATE_UNSPECIFIED": 0,
	"MQTT_ENABLED":           1,
	"MQTT_DISABLED":          2,
}
View Source 
var PublicKeyCertificateFormat_name = map[int32]string{
	0: "UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT",
	1: "X509_CERTIFICATE_PEM",
}
View Source 
var PublicKeyCertificateFormat_value = map[string]int32{
	"UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT": 0,
	"X509_CERTIFICATE_PEM":                      1,
}
View Source 
var PublicKeyFormat_name = map[int32]string{
	0: "UNSPECIFIED_PUBLIC_KEY_FORMAT",
	3: "RSA_PEM",
	1: "RSA_X509_PEM",
	2: "ES256_PEM",
	4: "ES256_X509_PEM",
}
View Source 
var PublicKeyFormat_value = map[string]int32{
	"UNSPECIFIED_PUBLIC_KEY_FORMAT": 0,
	"RSA_PEM":                       3,
	"RSA_X509_PEM":                  1,
	"ES256_PEM":                     2,
	"ES256_X509_PEM":                4,
}

Functions

func RegisterDeviceManagerServer 

func RegisterDeviceManagerServer(s *grpc.Server, srv DeviceManagerServer)

Types

type CreateDeviceRegistryRequest 

type CreateDeviceRegistryRequest struct {
	// The project and cloud region where this device registry must be created.
	// For example, `projects/example-project/locations/us-central1`.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// The device registry. The field `name` must be empty. The server will
	// generate that field from the device registry `id` provided and the
	// `parent` field.
	DeviceRegistry *DeviceRegistry `protobuf:"bytes,2,opt,name=device_registry,json=deviceRegistry" json:"device_registry,omitempty"`
}

Request for `CreateDeviceRegistry`.

func (*CreateDeviceRegistryRequest) Descriptor 

func (*CreateDeviceRegistryRequest) Descriptor() ([]byte, []int)

func (*CreateDeviceRegistryRequest) GetDeviceRegistry 

func (m *CreateDeviceRegistryRequest) GetDeviceRegistry() *DeviceRegistry

func (*CreateDeviceRegistryRequest) GetParent 

func (m *CreateDeviceRegistryRequest) GetParent() string

func (*CreateDeviceRegistryRequest) ProtoMessage 

func (*CreateDeviceRegistryRequest) ProtoMessage()

func (*CreateDeviceRegistryRequest) Reset 

func (m *CreateDeviceRegistryRequest) Reset()

func (*CreateDeviceRegistryRequest) String 

func (m *CreateDeviceRegistryRequest) String() string

type CreateDeviceRequest 

type CreateDeviceRequest struct {
	// The name of the device registry where this device should be created.
	// For example,
	// `projects/example-project/locations/us-central1/registries/my-registry`.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// The device registration details.
	Device *Device `protobuf:"bytes,2,opt,name=device" json:"device,omitempty"`
}

Request for `CreateDevice`.

func (*CreateDeviceRequest) Descriptor 

func (*CreateDeviceRequest) Descriptor() ([]byte, []int)

func (*CreateDeviceRequest) GetDevice 

func (m *CreateDeviceRequest) GetDevice() *Device

func (*CreateDeviceRequest) GetParent 

func (m *CreateDeviceRequest) GetParent() string

func (*CreateDeviceRequest) ProtoMessage 

func (*CreateDeviceRequest) ProtoMessage()

func (*CreateDeviceRequest) Reset 

func (m *CreateDeviceRequest) Reset()

func (*CreateDeviceRequest) String 

func (m *CreateDeviceRequest) String() string

type DeleteDeviceRegistryRequest 

type DeleteDeviceRegistryRequest struct {
	// The name of the device registry. For example,
	// `projects/example-project/locations/us-central1/registries/my-registry`.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

Request for `DeleteDeviceRegistry`.

func (*DeleteDeviceRegistryRequest) Descriptor 

func (*DeleteDeviceRegistryRequest) Descriptor() ([]byte, []int)

func (*DeleteDeviceRegistryRequest) GetName 

func (m *DeleteDeviceRegistryRequest) GetName() string

func (*DeleteDeviceRegistryRequest) ProtoMessage 

func (*DeleteDeviceRegistryRequest) ProtoMessage()

func (*DeleteDeviceRegistryRequest) Reset 

func (m *DeleteDeviceRegistryRequest) Reset()

func (*DeleteDeviceRegistryRequest) String 

func (m *DeleteDeviceRegistryRequest) String() string

type DeleteDeviceRequest 

type DeleteDeviceRequest struct {
	// The name of the device. For example,
	// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
	// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

Request for `DeleteDevice`.

func (*DeleteDeviceRequest) Descriptor 

func (*DeleteDeviceRequest) Descriptor() ([]byte, []int)

func (*DeleteDeviceRequest) GetName 

func (m *DeleteDeviceRequest) GetName() string

func (*DeleteDeviceRequest) ProtoMessage 

func (*DeleteDeviceRequest) ProtoMessage()

func (*DeleteDeviceRequest) Reset 

func (m *DeleteDeviceRequest) Reset()

func (*DeleteDeviceRequest) String 

func (m *DeleteDeviceRequest) String() string

type Device 

type Device struct {
	// The user-defined device identifier. The device ID must be unique
	// within a device registry.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The resource path name. For example,
	// `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or
	// `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.
	// When `name` is populated as a response from the service, it always ends
	// in the device numeric ID.
	Name string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// [Output only] A server-defined unique numeric ID for the device. This is a
	// more compact way to identify devices, and it is globally unique.
	NumId uint64 `protobuf:"varint,3,opt,name=num_id,json=numId" json:"num_id,omitempty"`
	// The credentials used to authenticate this device. To allow credential
	// rotation without interruption, multiple device credentials can be bound to
	// this device. No more than 3 credentials can be bound to a single device at
	// a time. When new credentials are added to a device, they are verified
	// against the registry credentials. For details, see the description of the
	// `DeviceRegistry.credentials` field.
	Credentials []*DeviceCredential `protobuf:"bytes,12,rep,name=credentials" json:"credentials,omitempty"`
	// [Output only] The last time a heartbeat was received. Timestamps are
	// periodically collected and written to storage; they may be stale by a few
	// minutes. This field is only for devices connecting through MQTT.
	LastHeartbeatTime *google_protobuf1.Timestamp `protobuf:"bytes,7,opt,name=last_heartbeat_time,json=lastHeartbeatTime" json:"last_heartbeat_time,omitempty"`
	// [Output only] The last time a telemetry event was received. Timestamps are
	// periodically collected and written to storage; they may be stale by a few
	// minutes.
	LastEventTime *google_protobuf1.Timestamp `protobuf:"bytes,8,opt,name=last_event_time,json=lastEventTime" json:"last_event_time,omitempty"`
	// [Output only] The last time a state event was received. Timestamps are
	// periodically collected and written to storage; they may be stale by a few
	// minutes.
	LastStateTime *google_protobuf1.Timestamp `protobuf:"bytes,20,opt,name=last_state_time,json=lastStateTime" json:"last_state_time,omitempty"`
	// [Output only] The last time a cloud-to-device config version acknowledgment
	// was received from the device. This field is only for configurations
	// sent through MQTT.
	LastConfigAckTime *google_protobuf1.Timestamp `protobuf:"bytes,14,opt,name=last_config_ack_time,json=lastConfigAckTime" json:"last_config_ack_time,omitempty"`
	// [Output only] The last time a cloud-to-device config version was sent to
	// the device.
	LastConfigSendTime *google_protobuf1.Timestamp `protobuf:"bytes,18,opt,name=last_config_send_time,json=lastConfigSendTime" json:"last_config_send_time,omitempty"`
	// If a device is blocked, connections or requests from this device will fail.
	// Can be used to temporarily prevent the device from connecting if, for
	// example, the sensor is generating bad data and needs maintenance.
	Blocked bool `protobuf:"varint,19,opt,name=blocked" json:"blocked,omitempty"`
	// [Output only] The time the most recent error occurred, such as a failure to
	// publish to Cloud Pub/Sub. This field is the timestamp of
	// 'last_error_status'.
	LastErrorTime *google_protobuf1.Timestamp `protobuf:"bytes,10,opt,name=last_error_time,json=lastErrorTime" json:"last_error_time,omitempty"`
	// [Output only] The error message of the most recent error, such as a failure
	// to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this
	// field. If no errors have occurred, this field has an empty message
	// and the status code 0 == OK. Otherwise, this field is expected to have a
	// status code other than OK.
	LastErrorStatus *google_rpc.Status `protobuf:"bytes,11,opt,name=last_error_status,json=lastErrorStatus" json:"last_error_status,omitempty"`
	// The most recent device configuration, which is eventually sent from
	// Cloud IoT Core to the device. If not present on creation, the
	// configuration will be initialized with an empty payload and version value
	// of `1`. To update this field after creation, use the
	// `DeviceManager.ModifyCloudToDeviceConfig` method.
	Config *DeviceConfig `protobuf:"bytes,13,opt,name=config" json:"config,omitempty"`
	// [Output only] The state most recently received from the device. If no state
	// has been reported, this field is not present.
	State *DeviceState `protobuf:"bytes,16,opt,name=state" json:"state,omitempty"`
	// The metadata key-value pairs assigned to the device. This metadata is not
	// interpreted or indexed by Cloud IoT Core. It can be used to add contextual
	// information for the device.
	//
	// Keys must conform to the regular expression [a-zA-Z0-9-_]+ and be less than
	// 128 bytes in length.
	//
	// Values are free-form strings. Each value must be less than or equal to 32
	// KB in size.
	//
	// The total size of all keys and values must be less than 256 KB, and the
	// maximum number of key-value pairs is 500.
	Metadata map[string]string `` /* 137-byte string literal not displayed */
}

The device resource.

func (*Device) Descriptor 

func (*Device) Descriptor() ([]byte, []int)

func (*Device) GetBlocked 

func (m *Device) GetBlocked() bool

func (*Device) GetConfig 

func (m *Device) GetConfig() *DeviceConfig

func (*Device) GetCredentials 

func (m *Device) GetCredentials() []*DeviceCredential

func (*Device) GetId 

func (m *Device) GetId() string

func (*Device) GetLastConfigAckTime 

func (m *Device) GetLastConfigAckTime() *google_protobuf1.Timestamp

func (*Device) GetLastConfigSendTime 

func (m *Device) GetLastConfigSendTime() *google_protobuf1.Timestamp

func (*Device) GetLastErrorStatus 

func (m *Device) GetLastErrorStatus() *google_rpc.Status

func (*Device) GetLastErrorTime 

func (m *Device) GetLastErrorTime() *google_protobuf1.Timestamp

func (*Device) GetLastEventTime 

func (m *Device) GetLastEventTime() *google_protobuf1.Timestamp

func (*Device) GetLastHeartbeatTime 

func (m *Device) GetLastHeartbeatTime() *google_protobuf1.Timestamp

func (*Device) GetLastStateTime 

func (m *Device) GetLastStateTime() *google_protobuf1.Timestamp

func (*Device) GetMetadata 

func (m *Device) GetMetadata() map[string]string

func (*Device) GetName 

func (m *Device) GetName() string

func (*Device) GetNumId 

func (m *Device) GetNumId() uint64

func (*Device) GetState 

func (m *Device) GetState() *DeviceState

func (*Device) ProtoMessage 

func (*Device) ProtoMessage()

func (*Device) Reset 

func (m *Device) Reset()

func (*Device) String 

func (m *Device) String() string

type DeviceConfig 

type DeviceConfig struct {
	// [Output only] The version of this update. The version number is assigned by
	// the server, and is always greater than 0 after device creation. The
	// version must be 0 on the `CreateDevice` request if a `config` is
	// specified; the response of `CreateDevice` will always have a value of 1.
	Version int64 `protobuf:"varint,1,opt,name=version" json:"version,omitempty"`
	// [Output only] The time at which this configuration version was updated in
	// Cloud IoT Core. This timestamp is set by the server.
	CloudUpdateTime *google_protobuf1.Timestamp `protobuf:"bytes,2,opt,name=cloud_update_time,json=cloudUpdateTime" json:"cloud_update_time,omitempty"`
	// [Output only] The time at which Cloud IoT Core received the
	// acknowledgment from the device, indicating that the device has received
	// this configuration version. If this field is not present, the device has
	// not yet acknowledged that it received this version. Note that when
	// the config was sent to the device, many config versions may have been
	// available in Cloud IoT Core while the device was disconnected, and on
	// connection, only the latest version is sent to the device. Some
	// versions may never be sent to the device, and therefore are never
	// acknowledged. This timestamp is set by Cloud IoT Core.
	DeviceAckTime *google_protobuf1.Timestamp `protobuf:"bytes,3,opt,name=device_ack_time,json=deviceAckTime" json:"device_ack_time,omitempty"`
	// The device configuration data.
	BinaryData []byte `protobuf:"bytes,4,opt,name=binary_data,json=binaryData,proto3" json:"binary_data,omitempty"`
}

The device configuration. Eventually delivered to devices.

func (*DeviceConfig) Descriptor 

func (*DeviceConfig) Descriptor() ([]byte, []int)

func (*DeviceConfig) GetBinaryData 

func (m *DeviceConfig) GetBinaryData() []byte

func (*DeviceConfig) GetCloudUpdateTime 

func (m *DeviceConfig) GetCloudUpdateTime() *google_protobuf1.Timestamp

func (*DeviceConfig) GetDeviceAckTime 

func (m *DeviceConfig) GetDeviceAckTime() *google_protobuf1.Timestamp

func (*DeviceConfig) GetVersion 

func (m *DeviceConfig) GetVersion() int64

func (*DeviceConfig) ProtoMessage 

func (*DeviceConfig) ProtoMessage()

func (*DeviceConfig) Reset 

func (m *DeviceConfig) Reset()

func (*DeviceConfig) String 

func (m *DeviceConfig) String() string

type DeviceCredential 

type DeviceCredential struct {
	// The credential data. Reserved for expansion in the future.
	//
	// Types that are valid to be assigned to Credential:
	//	*DeviceCredential_PublicKey
	Credential isDeviceCredential_Credential `protobuf_oneof:"credential"`
	// [Optional] The time at which this credential becomes invalid. This
	// credential will be ignored for new client authentication requests after
	// this timestamp; however, it will not be automatically deleted.
	ExpirationTime *google_protobuf1.Timestamp `protobuf:"bytes,6,opt,name=expiration_time,json=expirationTime" json:"expiration_time,omitempty"`
}

A server-stored device credential used for authentication.

func (*DeviceCredential) Descriptor 

func (*DeviceCredential) Descriptor() ([]byte, []int)

func (*DeviceCredential) GetCredential 

func (m *DeviceCredential) GetCredential() isDeviceCredential_Credential

func (*DeviceCredential) GetExpirationTime 

func (m *DeviceCredential) GetExpirationTime() *google_protobuf1.Timestamp

func (*DeviceCredential) GetPublicKey 

func (m *DeviceCredential) GetPublicKey() *PublicKeyCredential

func (*DeviceCredential) ProtoMessage 

func (*DeviceCredential) ProtoMessage()

func (*DeviceCredential) Reset 

func (m *DeviceCredential) Reset()

func (*DeviceCredential) String 

func (m *DeviceCredential) String() string

func (*DeviceCredential) XXX_OneofFuncs 

func (*DeviceCredential) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type DeviceCredential_PublicKey 

type DeviceCredential_PublicKey struct {
	PublicKey *PublicKeyCredential `protobuf:"bytes,2,opt,name=public_key,json=publicKey,oneof"`
}

type DeviceManagerClient 

type DeviceManagerClient interface {
	// Creates a device registry that contains devices.
	CreateDeviceRegistry(ctx context.Context, in *CreateDeviceRegistryRequest, opts ...grpc.CallOption) (*DeviceRegistry, error)
	// Gets a device registry configuration.
	GetDeviceRegistry(ctx context.Context, in *GetDeviceRegistryRequest, opts ...grpc.CallOption) (*DeviceRegistry, error)
	// Updates a device registry configuration.
	UpdateDeviceRegistry(ctx context.Context, in *UpdateDeviceRegistryRequest, opts ...grpc.CallOption) (*DeviceRegistry, error)
	// Deletes a device registry configuration.
	DeleteDeviceRegistry(ctx context.Context, in *DeleteDeviceRegistryRequest, opts ...grpc.CallOption) (*google_protobuf3.Empty, error)
	// Lists device registries.
	ListDeviceRegistries(ctx context.Context, in *ListDeviceRegistriesRequest, opts ...grpc.CallOption) (*ListDeviceRegistriesResponse, error)
	// Creates a device in a device registry.
	CreateDevice(ctx context.Context, in *CreateDeviceRequest, opts ...grpc.CallOption) (*Device, error)
	// Gets details about a device.
	GetDevice(ctx context.Context, in *GetDeviceRequest, opts ...grpc.CallOption) (*Device, error)
	// Updates a device.
	UpdateDevice(ctx context.Context, in *UpdateDeviceRequest, opts ...grpc.CallOption) (*Device, error)
	// Deletes a device.
	DeleteDevice(ctx context.Context, in *DeleteDeviceRequest, opts ...grpc.CallOption) (*google_protobuf3.Empty, error)
	// List devices in a device registry.
	ListDevices(ctx context.Context, in *ListDevicesRequest, opts ...grpc.CallOption) (*ListDevicesResponse, error)
	// Modifies the configuration for the device, which is eventually sent from
	// the Cloud IoT Core servers. Returns the modified configuration version and
	// its metadata.
	ModifyCloudToDeviceConfig(ctx context.Context, in *ModifyCloudToDeviceConfigRequest, opts ...grpc.CallOption) (*DeviceConfig, error)
	// Lists the last few versions of the device configuration in descending
	// order (i.e.: newest first).
	ListDeviceConfigVersions(ctx context.Context, in *ListDeviceConfigVersionsRequest, opts ...grpc.CallOption) (*ListDeviceConfigVersionsResponse, error)
	// Lists the last few versions of the device state in descending order (i.e.:
	// newest first).
	ListDeviceStates(ctx context.Context, in *ListDeviceStatesRequest, opts ...grpc.CallOption) (*ListDeviceStatesResponse, error)
	// Sets the access control policy on the specified resource. Replaces any
	// existing policy.
	SetIamPolicy(ctx context.Context, in *google_iam_v11.SetIamPolicyRequest, opts ...grpc.CallOption) (*google_iam_v1.Policy, error)
	// Gets the access control policy for a resource.
	// Returns an empty policy if the resource exists and does not have a policy
	// set.
	GetIamPolicy(ctx context.Context, in *google_iam_v11.GetIamPolicyRequest, opts ...grpc.CallOption) (*google_iam_v1.Policy, error)
	// Returns permissions that a caller has on the specified resource.
	// If the resource does not exist, this will return an empty set of
	// permissions, not a NOT_FOUND error.
	TestIamPermissions(ctx context.Context, in *google_iam_v11.TestIamPermissionsRequest, opts ...grpc.CallOption) (*google_iam_v11.TestIamPermissionsResponse, error)
}

func NewDeviceManagerClient 

func NewDeviceManagerClient(cc *grpc.ClientConn) DeviceManagerClient

type DeviceManagerServer 

type DeviceManagerServer interface {
	// Creates a device registry that contains devices.
	CreateDeviceRegistry(context.Context, *CreateDeviceRegistryRequest) (*DeviceRegistry, error)
	// Gets a device registry configuration.
	GetDeviceRegistry(context.Context, *GetDeviceRegistryRequest) (*DeviceRegistry, error)
	// Updates a device registry configuration.
	UpdateDeviceRegistry(context.Context, *UpdateDeviceRegistryRequest) (*DeviceRegistry, error)
	// Deletes a device registry configuration.
	DeleteDeviceRegistry(context.Context, *DeleteDeviceRegistryRequest) (*google_protobuf3.Empty, error)
	// Lists device registries.
	ListDeviceRegistries(context.Context, *ListDeviceRegistriesRequest) (*ListDeviceRegistriesResponse, error)
	// Creates a device in a device registry.
	CreateDevice(context.Context, *CreateDeviceRequest) (*Device, error)
	// Gets details about a device.
	GetDevice(context.Context, *GetDeviceRequest) (*Device, error)
	// Updates a device.
	UpdateDevice(context.Context, *UpdateDeviceRequest) (*Device, error)
	// Deletes a device.
	DeleteDevice(context.Context, *DeleteDeviceRequest) (*google_protobuf3.Empty, error)
	// List devices in a device registry.
	ListDevices(context.Context, *ListDevicesRequest) (*ListDevicesResponse, error)
	// Modifies the configuration for the device, which is eventually sent from
	// the Cloud IoT Core servers. Returns the modified configuration version and
	// its metadata.
	ModifyCloudToDeviceConfig(context.Context, *ModifyCloudToDeviceConfigRequest) (*DeviceConfig, error)
	// Lists the last few versions of the device configuration in descending
	// order (i.e.: newest first).
	ListDeviceConfigVersions(context.Context, *ListDeviceConfigVersionsRequest) (*ListDeviceConfigVersionsResponse, error)
	// Lists the last few versions of the device state in descending order (i.e.:
	// newest first).
	ListDeviceStates(context.Context, *ListDeviceStatesRequest) (*ListDeviceStatesResponse, error)
	// Sets the access control policy on the specified resource. Replaces any
	// existing policy.
	SetIamPolicy(context.Context, *google_iam_v11.SetIamPolicyRequest) (*google_iam_v1.Policy, error)
	// Gets the access control policy for a resource.
	// Returns an empty policy if the resource exists and does not have a policy
	// set.
	GetIamPolicy(context.Context, *google_iam_v11.GetIamPolicyRequest) (*google_iam_v1.Policy, error)
	// Returns permissions that a caller has on the specified resource.
	// If the resource does not exist, this will return an empty set of
	// permissions, not a NOT_FOUND error.
	TestIamPermissions(context.Context, *google_iam_v11.TestIamPermissionsRequest) (*google_iam_v11.TestIamPermissionsResponse, error)
}

type DeviceRegistry 

type DeviceRegistry struct {
	// The identifier of this device registry. For example, `myRegistry`.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The resource path name. For example,
	// `projects/example-project/locations/us-central1/registries/my-registry`.
	Name string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// The configuration for notification of telemetry events received from the
	// device. All telemetry events that were successfully published by the
	// device and acknowledged by Cloud IoT Core are guaranteed to be
	// delivered to Cloud Pub/Sub. Only the first configuration is used. If you
	// try to publish a device telemetry event using MQTT without specifying a
	// Cloud Pub/Sub topic for the device's registry, the connection closes
	// automatically. If you try to do so using an HTTP connection, an error
	// is returned.
	EventNotificationConfigs []*EventNotificationConfig `` /* 129-byte string literal not displayed */
	// The configuration for notification of new states received from the device.
	// State updates are guaranteed to be stored in the state history, but
	// notifications to Cloud Pub/Sub are not guaranteed. For example, if
	// permissions are misconfigured or the specified topic doesn't exist, no
	// notification will be published but the state will still be stored in Cloud
	// IoT Core.
	StateNotificationConfig *StateNotificationConfig `protobuf:"bytes,7,opt,name=state_notification_config,json=stateNotificationConfig" json:"state_notification_config,omitempty"`
	// The MQTT configuration for this device registry.
	MqttConfig *MqttConfig `protobuf:"bytes,4,opt,name=mqtt_config,json=mqttConfig" json:"mqtt_config,omitempty"`
	// The DeviceService (HTTP) configuration for this device registry.
	HttpConfig *HttpConfig `protobuf:"bytes,9,opt,name=http_config,json=httpConfig" json:"http_config,omitempty"`
	// The credentials used to verify the device credentials. No more than 10
	// credentials can be bound to a single registry at a time. The verification
	// process occurs at the time of device creation or update. If this field is
	// empty, no verification is performed. Otherwise, the credentials of a newly
	// created device or added credentials of an updated device should be signed
	// with one of these registry credentials.
	//
	// Note, however, that existing devices will never be affected by
	// modifications to this list of credentials: after a device has been
	// successfully created in a registry, it should be able to connect even if
	// its registry credentials are revoked, deleted, or modified.
	Credentials []*RegistryCredential `protobuf:"bytes,8,rep,name=credentials" json:"credentials,omitempty"`
}

A container for a group of devices.

func (*DeviceRegistry) Descriptor 

func (*DeviceRegistry) Descriptor() ([]byte, []int)

func (*DeviceRegistry) GetCredentials 

func (m *DeviceRegistry) GetCredentials() []*RegistryCredential

func (*DeviceRegistry) GetEventNotificationConfigs 

func (m *DeviceRegistry) GetEventNotificationConfigs() []*EventNotificationConfig

func (*DeviceRegistry) GetHttpConfig 

func (m *DeviceRegistry) GetHttpConfig() *HttpConfig

func (*DeviceRegistry) GetId 

func (m *DeviceRegistry) GetId() string

func (*DeviceRegistry) GetMqttConfig 

func (m *DeviceRegistry) GetMqttConfig() *MqttConfig

func (*DeviceRegistry) GetName 

func (m *DeviceRegistry) GetName() string

func (*DeviceRegistry) GetStateNotificationConfig 

func (m *DeviceRegistry) GetStateNotificationConfig() *StateNotificationConfig

func (*DeviceRegistry) ProtoMessage 

func (*DeviceRegistry) ProtoMessage()

func (*DeviceRegistry) Reset 

func (m *DeviceRegistry) Reset()

func (*DeviceRegistry) String 

func (m *DeviceRegistry) String() string

type DeviceState 

type DeviceState struct {
	// [Output only] The time at which this state version was updated in Cloud
	// IoT Core.
	UpdateTime *google_protobuf1.Timestamp `protobuf:"bytes,1,opt,name=update_time,json=updateTime" json:"update_time,omitempty"`
	// The device state data.
	BinaryData []byte `protobuf:"bytes,2,opt,name=binary_data,json=binaryData,proto3" json:"binary_data,omitempty"`
}

The device state, as reported by the device.

func (*DeviceState) Descriptor 

func (*DeviceState) Descriptor() ([]byte, []int)

func (*DeviceState) GetBinaryData 

func (m *DeviceState) GetBinaryData() []byte

func (*DeviceState) GetUpdateTime 

func (m *DeviceState) GetUpdateTime() *google_protobuf1.Timestamp

func (*DeviceState) ProtoMessage 

func (*DeviceState) ProtoMessage()

func (*DeviceState) Reset 

func (m *DeviceState) Reset()

func (*DeviceState) String 

func (m *DeviceState) String() string

type EventNotificationConfig 

type EventNotificationConfig struct {
	// A Cloud Pub/Sub topic name. For example,
	// `projects/myProject/topics/deviceEvents`.
	PubsubTopicName string `protobuf:"bytes,1,opt,name=pubsub_topic_name,json=pubsubTopicName" json:"pubsub_topic_name,omitempty"`
}

The configuration to forward telemetry events.

func (*EventNotificationConfig) Descriptor 

func (*EventNotificationConfig) Descriptor() ([]byte, []int)

func (*EventNotificationConfig) GetPubsubTopicName 

func (m *EventNotificationConfig) GetPubsubTopicName() string

func (*EventNotificationConfig) ProtoMessage 

func (*EventNotificationConfig) ProtoMessage()

func (*EventNotificationConfig) Reset 

func (m *EventNotificationConfig) Reset()

func (*EventNotificationConfig) String 

func (m *EventNotificationConfig) String() string

type GetDeviceRegistryRequest 

type GetDeviceRegistryRequest struct {
	// The name of the device registry. For example,
	// `projects/example-project/locations/us-central1/registries/my-registry`.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

Request for `GetDeviceRegistry`.

func (*GetDeviceRegistryRequest) Descriptor 

func (*GetDeviceRegistryRequest) Descriptor() ([]byte, []int)

func (*GetDeviceRegistryRequest) GetName 

func (m *GetDeviceRegistryRequest) GetName() string

func (*GetDeviceRegistryRequest) ProtoMessage 

func (*GetDeviceRegistryRequest) ProtoMessage()

func (*GetDeviceRegistryRequest) Reset 

func (m *GetDeviceRegistryRequest) Reset()

func (*GetDeviceRegistryRequest) String 

func (m *GetDeviceRegistryRequest) String() string

type GetDeviceRequest 

type GetDeviceRequest struct {
	// The name of the device. For example,
	// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
	// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The fields of the `Device` resource to be returned in the response. If the
	// field mask is unset or empty, all fields are returned.
	FieldMask *google_protobuf4.FieldMask `protobuf:"bytes,2,opt,name=field_mask,json=fieldMask" json:"field_mask,omitempty"`
}

Request for `GetDevice`.

func (*GetDeviceRequest) Descriptor 

func (*GetDeviceRequest) Descriptor() ([]byte, []int)

func (*GetDeviceRequest) GetFieldMask 

func (m *GetDeviceRequest) GetFieldMask() *google_protobuf4.FieldMask

func (*GetDeviceRequest) GetName 

func (m *GetDeviceRequest) GetName() string

func (*GetDeviceRequest) ProtoMessage 

func (*GetDeviceRequest) ProtoMessage()

func (*GetDeviceRequest) Reset 

func (m *GetDeviceRequest) Reset()

func (*GetDeviceRequest) String 

func (m *GetDeviceRequest) String() string

type HttpConfig 

type HttpConfig struct {
	// If enabled, allows devices to use DeviceService via the HTTP protocol.
	// Otherwise, any requests to DeviceService will fail for this registry.
	HttpEnabledState HttpState `` /* 140-byte string literal not displayed */
}

The configuration of the HTTP bridge for a device registry.

func (*HttpConfig) Descriptor 

func (*HttpConfig) Descriptor() ([]byte, []int)

func (*HttpConfig) GetHttpEnabledState 

func (m *HttpConfig) GetHttpEnabledState() HttpState

func (*HttpConfig) ProtoMessage 

func (*HttpConfig) ProtoMessage()

func (*HttpConfig) Reset 

func (m *HttpConfig) Reset()

func (*HttpConfig) String 

func (m *HttpConfig) String() string

type HttpState 

type HttpState int32

Indicates whether DeviceService (HTTP) is enabled or disabled for the registry. See the field description for details. 

const (
	// No HTTP state specified. If not specified, DeviceService will be
	// enabled by default.
	HttpState_HTTP_STATE_UNSPECIFIED HttpState = 0
	// Enables DeviceService (HTTP) service for the registry.
	HttpState_HTTP_ENABLED HttpState = 1
	// Disables DeviceService (HTTP) service for the registry.
	HttpState_HTTP_DISABLED HttpState = 2
)

func (HttpState) EnumDescriptor 

func (HttpState) EnumDescriptor() ([]byte, []int)

func (HttpState) String 

func (x HttpState) String() string

type ListDeviceConfigVersionsRequest 

type ListDeviceConfigVersionsRequest struct {
	// The name of the device. For example,
	// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
	// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The number of versions to list. Versions are listed in decreasing order of
	// the version number. The maximum number of versions retained is 10. If this
	// value is zero, it will return all the versions available.
	NumVersions int32 `protobuf:"varint,2,opt,name=num_versions,json=numVersions" json:"num_versions,omitempty"`
}

Request for `ListDeviceConfigVersions`.

func (*ListDeviceConfigVersionsRequest) Descriptor 

func (*ListDeviceConfigVersionsRequest) Descriptor() ([]byte, []int)

func (*ListDeviceConfigVersionsRequest) GetName 

func (m *ListDeviceConfigVersionsRequest) GetName() string

func (*ListDeviceConfigVersionsRequest) GetNumVersions 

func (m *ListDeviceConfigVersionsRequest) GetNumVersions() int32

func (*ListDeviceConfigVersionsRequest) ProtoMessage 

func (*ListDeviceConfigVersionsRequest) ProtoMessage()

func (*ListDeviceConfigVersionsRequest) Reset 

func (m *ListDeviceConfigVersionsRequest) Reset()

func (*ListDeviceConfigVersionsRequest) String 

func (m *ListDeviceConfigVersionsRequest) String() string

type ListDeviceConfigVersionsResponse 

type ListDeviceConfigVersionsResponse struct {
	// The device configuration for the last few versions. Versions are listed
	// in decreasing order, starting from the most recent one.
	DeviceConfigs []*DeviceConfig `protobuf:"bytes,1,rep,name=device_configs,json=deviceConfigs" json:"device_configs,omitempty"`
}

Response for `ListDeviceConfigVersions`.

func (*ListDeviceConfigVersionsResponse) Descriptor 

func (*ListDeviceConfigVersionsResponse) Descriptor() ([]byte, []int)

func (*ListDeviceConfigVersionsResponse) GetDeviceConfigs 

func (m *ListDeviceConfigVersionsResponse) GetDeviceConfigs() []*DeviceConfig

func (*ListDeviceConfigVersionsResponse) ProtoMessage 

func (*ListDeviceConfigVersionsResponse) ProtoMessage()

func (*ListDeviceConfigVersionsResponse) Reset 

func (m *ListDeviceConfigVersionsResponse) Reset()

func (*ListDeviceConfigVersionsResponse) String 

func (m *ListDeviceConfigVersionsResponse) String() string

type ListDeviceRegistriesRequest 

type ListDeviceRegistriesRequest struct {
	// The project and cloud region path. For example,
	// `projects/example-project/locations/us-central1`.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// The maximum number of registries to return in the response. If this value
	// is zero, the service will select a default size. A call may return fewer
	// objects than requested, but if there is a non-empty `page_token`, it
	// indicates that more entries are available.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	// The value returned by the last `ListDeviceRegistriesResponse`; indicates
	// that this is a continuation of a prior `ListDeviceRegistries` call, and
	// that the system should return the next page of data.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}

Request for `ListDeviceRegistries`.

func (*ListDeviceRegistriesRequest) Descriptor 

func (*ListDeviceRegistriesRequest) Descriptor() ([]byte, []int)

func (*ListDeviceRegistriesRequest) GetPageSize 

func (m *ListDeviceRegistriesRequest) GetPageSize() int32

func (*ListDeviceRegistriesRequest) GetPageToken 

func (m *ListDeviceRegistriesRequest) GetPageToken() string

func (*ListDeviceRegistriesRequest) GetParent 

func (m *ListDeviceRegistriesRequest) GetParent() string

func (*ListDeviceRegistriesRequest) ProtoMessage 

func (*ListDeviceRegistriesRequest) ProtoMessage()

func (*ListDeviceRegistriesRequest) Reset 

func (m *ListDeviceRegistriesRequest) Reset()

func (*ListDeviceRegistriesRequest) String 

func (m *ListDeviceRegistriesRequest) String() string

type ListDeviceRegistriesResponse 

type ListDeviceRegistriesResponse struct {
	// The registries that matched the query.
	DeviceRegistries []*DeviceRegistry `protobuf:"bytes,1,rep,name=device_registries,json=deviceRegistries" json:"device_registries,omitempty"`
	// If not empty, indicates that there may be more registries that match the
	// request; this value should be passed in a new
	// `ListDeviceRegistriesRequest`.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}

Response for `ListDeviceRegistries`.

func (*ListDeviceRegistriesResponse) Descriptor 

func (*ListDeviceRegistriesResponse) Descriptor() ([]byte, []int)

func (*ListDeviceRegistriesResponse) GetDeviceRegistries 

func (m *ListDeviceRegistriesResponse) GetDeviceRegistries() []*DeviceRegistry

func (*ListDeviceRegistriesResponse) GetNextPageToken 

func (m *ListDeviceRegistriesResponse) GetNextPageToken() string

func (*ListDeviceRegistriesResponse) ProtoMessage 

func (*ListDeviceRegistriesResponse) ProtoMessage()

func (*ListDeviceRegistriesResponse) Reset 

func (m *ListDeviceRegistriesResponse) Reset()

func (*ListDeviceRegistriesResponse) String 

func (m *ListDeviceRegistriesResponse) String() string

type ListDeviceStatesRequest 

type ListDeviceStatesRequest struct {
	// The name of the device. For example,
	// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
	// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The number of states to list. States are listed in descending order of
	// update time. The maximum number of states retained is 10. If this
	// value is zero, it will return all the states available.
	NumStates int32 `protobuf:"varint,2,opt,name=num_states,json=numStates" json:"num_states,omitempty"`
}

Request for `ListDeviceStates`.

func (*ListDeviceStatesRequest) Descriptor 

func (*ListDeviceStatesRequest) Descriptor() ([]byte, []int)

func (*ListDeviceStatesRequest) GetName 

func (m *ListDeviceStatesRequest) GetName() string

func (*ListDeviceStatesRequest) GetNumStates 

func (m *ListDeviceStatesRequest) GetNumStates() int32

func (*ListDeviceStatesRequest) ProtoMessage 

func (*ListDeviceStatesRequest) ProtoMessage()

func (*ListDeviceStatesRequest) Reset 

func (m *ListDeviceStatesRequest) Reset()

func (*ListDeviceStatesRequest) String 

func (m *ListDeviceStatesRequest) String() string

type ListDeviceStatesResponse 

type ListDeviceStatesResponse struct {
	// The last few device states. States are listed in descending order of server
	// update time, starting from the most recent one.
	DeviceStates []*DeviceState `protobuf:"bytes,1,rep,name=device_states,json=deviceStates" json:"device_states,omitempty"`
}

Response for `ListDeviceStates`.

func (*ListDeviceStatesResponse) Descriptor 

func (*ListDeviceStatesResponse) Descriptor() ([]byte, []int)

func (*ListDeviceStatesResponse) GetDeviceStates 

func (m *ListDeviceStatesResponse) GetDeviceStates() []*DeviceState

func (*ListDeviceStatesResponse) ProtoMessage 

func (*ListDeviceStatesResponse) ProtoMessage()

func (*ListDeviceStatesResponse) Reset 

func (m *ListDeviceStatesResponse) Reset()

func (*ListDeviceStatesResponse) String 

func (m *ListDeviceStatesResponse) String() string

type ListDevicesRequest 

type ListDevicesRequest struct {
	// The device registry path. Required. For example,
	// `projects/my-project/locations/us-central1/registries/my-registry`.
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// A list of device numerical ids. If empty, it will ignore this field. This
	// field cannot hold more than 10,000 entries.
	DeviceNumIds []uint64 `protobuf:"varint,2,rep,packed,name=device_num_ids,json=deviceNumIds" json:"device_num_ids,omitempty"`
	// A list of device string identifiers. If empty, it will ignore this field.
	// For example, `['device0', 'device12']`. This field cannot hold more than
	// 10,000 entries.
	DeviceIds []string `protobuf:"bytes,3,rep,name=device_ids,json=deviceIds" json:"device_ids,omitempty"`
	// The fields of the `Device` resource to be returned in the response. The
	// fields `id`, and `num_id` are always returned by default, along with any
	// other fields specified.
	FieldMask *google_protobuf4.FieldMask `protobuf:"bytes,4,opt,name=field_mask,json=fieldMask" json:"field_mask,omitempty"`
	// The maximum number of devices to return in the response. If this value
	// is zero, the service will select a default size. A call may return fewer
	// objects than requested, but if there is a non-empty `page_token`, it
	// indicates that more entries are available.
	PageSize int32 `protobuf:"varint,100,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	// The value returned by the last `ListDevicesResponse`; indicates
	// that this is a continuation of a prior `ListDevices` call, and
	// that the system should return the next page of data.
	PageToken string `protobuf:"bytes,101,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}

Request for `ListDevices`.

func (*ListDevicesRequest) Descriptor 

func (*ListDevicesRequest) Descriptor() ([]byte, []int)

func (*ListDevicesRequest) GetDeviceIds 

func (m *ListDevicesRequest) GetDeviceIds() []string

func (*ListDevicesRequest) GetDeviceNumIds 

func (m *ListDevicesRequest) GetDeviceNumIds() []uint64

func (*ListDevicesRequest) GetFieldMask 

func (m *ListDevicesRequest) GetFieldMask() *google_protobuf4.FieldMask

func (*ListDevicesRequest) GetPageSize 

func (m *ListDevicesRequest) GetPageSize() int32

func (*ListDevicesRequest) GetPageToken 

func (m *ListDevicesRequest) GetPageToken() string

func (*ListDevicesRequest) GetParent 

func (m *ListDevicesRequest) GetParent() string

func (*ListDevicesRequest) ProtoMessage 

func (*ListDevicesRequest) ProtoMessage()

func (*ListDevicesRequest) Reset 

func (m *ListDevicesRequest) Reset()

func (*ListDevicesRequest) String 

func (m *ListDevicesRequest) String() string

type ListDevicesResponse 

type ListDevicesResponse struct {
	// The devices that match the request.
	Devices []*Device `protobuf:"bytes,1,rep,name=devices" json:"devices,omitempty"`
	// If not empty, indicates that there may be more devices that match the
	// request; this value should be passed in a new `ListDevicesRequest`.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}

Response for `ListDevices`.

func (*ListDevicesResponse) Descriptor 

func (*ListDevicesResponse) Descriptor() ([]byte, []int)

func (*ListDevicesResponse) GetDevices 

func (m *ListDevicesResponse) GetDevices() []*Device

func (*ListDevicesResponse) GetNextPageToken 

func (m *ListDevicesResponse) GetNextPageToken() string

func (*ListDevicesResponse) ProtoMessage 

func (*ListDevicesResponse) ProtoMessage()

func (*ListDevicesResponse) Reset 

func (m *ListDevicesResponse) Reset()

func (*ListDevicesResponse) String 

func (m *ListDevicesResponse) String() string

type ModifyCloudToDeviceConfigRequest 

type ModifyCloudToDeviceConfigRequest struct {
	// The name of the device. For example,
	// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
	// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The version number to update. If this value is zero, it will not check the
	// version number of the server and will always update the current version;
	// otherwise, this update will fail if the version number found on the server
	// does not match this version number. This is used to support multiple
	// simultaneous updates without losing data.
	VersionToUpdate int64 `protobuf:"varint,2,opt,name=version_to_update,json=versionToUpdate" json:"version_to_update,omitempty"`
	// The configuration data for the device.
	BinaryData []byte `protobuf:"bytes,3,opt,name=binary_data,json=binaryData,proto3" json:"binary_data,omitempty"`
}

Request for `ModifyCloudToDeviceConfig`.

func (*ModifyCloudToDeviceConfigRequest) Descriptor 

func (*ModifyCloudToDeviceConfigRequest) Descriptor() ([]byte, []int)

func (*ModifyCloudToDeviceConfigRequest) GetBinaryData 

func (m *ModifyCloudToDeviceConfigRequest) GetBinaryData() []byte

func (*ModifyCloudToDeviceConfigRequest) GetName 

func (m *ModifyCloudToDeviceConfigRequest) GetName() string

func (*ModifyCloudToDeviceConfigRequest) GetVersionToUpdate 

func (m *ModifyCloudToDeviceConfigRequest) GetVersionToUpdate() int64

func (*ModifyCloudToDeviceConfigRequest) ProtoMessage 

func (*ModifyCloudToDeviceConfigRequest) ProtoMessage()

func (*ModifyCloudToDeviceConfigRequest) Reset 

func (m *ModifyCloudToDeviceConfigRequest) Reset()

func (*ModifyCloudToDeviceConfigRequest) String 

func (m *ModifyCloudToDeviceConfigRequest) String() string

type MqttConfig 

type MqttConfig struct {
	// If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
	// connections to this registry will fail.
	MqttEnabledState MqttState `` /* 140-byte string literal not displayed */
}

The configuration of MQTT for a device registry.

func (*MqttConfig) Descriptor 

func (*MqttConfig) Descriptor() ([]byte, []int)

func (*MqttConfig) GetMqttEnabledState 

func (m *MqttConfig) GetMqttEnabledState() MqttState

func (*MqttConfig) ProtoMessage 

func (*MqttConfig) ProtoMessage()

func (*MqttConfig) Reset 

func (m *MqttConfig) Reset()

func (*MqttConfig) String 

func (m *MqttConfig) String() string

type MqttState 

type MqttState int32

Indicates whether an MQTT connection is enabled or disabled. See the field description for details. 

const (
	// No MQTT state specified. If not specified, MQTT will be enabled by default.
	MqttState_MQTT_STATE_UNSPECIFIED MqttState = 0
	// Enables a MQTT connection.
	MqttState_MQTT_ENABLED MqttState = 1
	// Disables a MQTT connection.
	MqttState_MQTT_DISABLED MqttState = 2
)

func (MqttState) EnumDescriptor 

func (MqttState) EnumDescriptor() ([]byte, []int)

func (MqttState) String 

func (x MqttState) String() string

type PublicKeyCertificate 

type PublicKeyCertificate struct {
	// The certificate format.
	Format PublicKeyCertificateFormat `protobuf:"varint,1,opt,name=format,enum=google.cloud.iot.v1.PublicKeyCertificateFormat" json:"format,omitempty"`
	// The certificate data.
	Certificate string `protobuf:"bytes,2,opt,name=certificate" json:"certificate,omitempty"`
	// [Output only] The certificate details. Used only for X.509 certificates.
	X509Details *X509CertificateDetails `protobuf:"bytes,3,opt,name=x509_details,json=x509Details" json:"x509_details,omitempty"`
}

A public key certificate format and data.

func (*PublicKeyCertificate) Descriptor 

func (*PublicKeyCertificate) Descriptor() ([]byte, []int)

func (*PublicKeyCertificate) GetCertificate 

func (m *PublicKeyCertificate) GetCertificate() string

func (*PublicKeyCertificate) GetFormat 

func (m *PublicKeyCertificate) GetFormat() PublicKeyCertificateFormat

func (*PublicKeyCertificate) GetX509Details 

func (m *PublicKeyCertificate) GetX509Details() *X509CertificateDetails

func (*PublicKeyCertificate) ProtoMessage 

func (*PublicKeyCertificate) ProtoMessage()

func (*PublicKeyCertificate) Reset 

func (m *PublicKeyCertificate) Reset()

func (*PublicKeyCertificate) String 

func (m *PublicKeyCertificate) String() string

type PublicKeyCertificateFormat 

type PublicKeyCertificateFormat int32

The supported formats for the public key. 

const (
	// The format has not been specified. This is an invalid default value and
	// must not be used.
	PublicKeyCertificateFormat_UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT PublicKeyCertificateFormat = 0
	// An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)),
	// encoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and
	// `-----END CERTIFICATE-----`.
	PublicKeyCertificateFormat_X509_CERTIFICATE_PEM PublicKeyCertificateFormat = 1
)

func (PublicKeyCertificateFormat) EnumDescriptor 

func (PublicKeyCertificateFormat) EnumDescriptor() ([]byte, []int)

func (PublicKeyCertificateFormat) String 

func (x PublicKeyCertificateFormat) String() string

type PublicKeyCredential 

type PublicKeyCredential struct {
	// The format of the key.
	Format PublicKeyFormat `protobuf:"varint,1,opt,name=format,enum=google.cloud.iot.v1.PublicKeyFormat" json:"format,omitempty"`
	// The key data.
	Key string `protobuf:"bytes,2,opt,name=key" json:"key,omitempty"`
}

A public key format and data.

func (*PublicKeyCredential) Descriptor 

func (*PublicKeyCredential) Descriptor() ([]byte, []int)

func (*PublicKeyCredential) GetFormat 

func (m *PublicKeyCredential) GetFormat() PublicKeyFormat

func (*PublicKeyCredential) GetKey 

func (m *PublicKeyCredential) GetKey() string

func (*PublicKeyCredential) ProtoMessage 

func (*PublicKeyCredential) ProtoMessage()

func (*PublicKeyCredential) Reset 

func (m *PublicKeyCredential) Reset()

func (*PublicKeyCredential) String 

func (m *PublicKeyCredential) String() string

type PublicKeyFormat 

type PublicKeyFormat int32

The supported formats for the public key. 

const (
	// The format has not been specified. This is an invalid default value and
	// must not be used.
	PublicKeyFormat_UNSPECIFIED_PUBLIC_KEY_FORMAT PublicKeyFormat = 0
	// An RSA public key encoded in base64, and wrapped by
	// `-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be
	// used to verify `RS256` signatures in JWT tokens ([RFC7518](
	// https://www.ietf.org/rfc/rfc7518.txt)).
	PublicKeyFormat_RSA_PEM PublicKeyFormat = 3
	// As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](
	// https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by
	// `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.
	PublicKeyFormat_RSA_X509_PEM PublicKeyFormat = 1
	// Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in
	// base64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END
	// PUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`
	// algorithm ([RFC7518](https://www.ietf.org/rfc/rfc7518.txt)). This curve is
	// defined in [OpenSSL](https://www.openssl.org/) as the `prime256v1` curve.
	PublicKeyFormat_ES256_PEM PublicKeyFormat = 2
	// As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](
	// https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by
	// `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.
	PublicKeyFormat_ES256_X509_PEM PublicKeyFormat = 4
)

func (PublicKeyFormat) EnumDescriptor 

func (PublicKeyFormat) EnumDescriptor() ([]byte, []int)

func (PublicKeyFormat) String 

func (x PublicKeyFormat) String() string

type RegistryCredential 

type RegistryCredential struct {
	// The credential data. Reserved for expansion in the future.
	//
	// Types that are valid to be assigned to Credential:
	//	*RegistryCredential_PublicKeyCertificate
	Credential isRegistryCredential_Credential `protobuf_oneof:"credential"`
}

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

func (*RegistryCredential) Descriptor 

func (*RegistryCredential) Descriptor() ([]byte, []int)

func (*RegistryCredential) GetCredential 

func (m *RegistryCredential) GetCredential() isRegistryCredential_Credential

func (*RegistryCredential) GetPublicKeyCertificate 

func (m *RegistryCredential) GetPublicKeyCertificate() *PublicKeyCertificate

func (*RegistryCredential) ProtoMessage 

func (*RegistryCredential) ProtoMessage()

func (*RegistryCredential) Reset 

func (m *RegistryCredential) Reset()

func (*RegistryCredential) String 

func (m *RegistryCredential) String() string

func (*RegistryCredential) XXX_OneofFuncs 

func (*RegistryCredential) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type RegistryCredential_PublicKeyCertificate 

type RegistryCredential_PublicKeyCertificate struct {
	PublicKeyCertificate *PublicKeyCertificate `protobuf:"bytes,1,opt,name=public_key_certificate,json=publicKeyCertificate,oneof"`
}

type StateNotificationConfig 

type StateNotificationConfig struct {
	// A Cloud Pub/Sub topic name. For example,
	// `projects/myProject/topics/deviceEvents`.
	PubsubTopicName string `protobuf:"bytes,1,opt,name=pubsub_topic_name,json=pubsubTopicName" json:"pubsub_topic_name,omitempty"`
}

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

func (*StateNotificationConfig) Descriptor 

func (*StateNotificationConfig) Descriptor() ([]byte, []int)

func (*StateNotificationConfig) GetPubsubTopicName 

func (m *StateNotificationConfig) GetPubsubTopicName() string

func (*StateNotificationConfig) ProtoMessage 

func (*StateNotificationConfig) ProtoMessage()

func (*StateNotificationConfig) Reset 

func (m *StateNotificationConfig) Reset()

func (*StateNotificationConfig) String 

func (m *StateNotificationConfig) String() string

type UpdateDeviceRegistryRequest 

type UpdateDeviceRegistryRequest struct {
	// The new values for the device registry. The `id` field must be empty, and
	// the `name` field must indicate the path of the resource. For example,
	// `projects/example-project/locations/us-central1/registries/my-registry`.
	DeviceRegistry *DeviceRegistry `protobuf:"bytes,1,opt,name=device_registry,json=deviceRegistry" json:"device_registry,omitempty"`
	// Only updates the `device_registry` fields indicated by this mask.
	// The field mask must not be empty, and it must not contain fields that
	// are immutable or only set by the server.
	// Mutable top-level fields: `event_notification_config`, `http_config`,
	// `mqtt_config`, and `state_notification_config`.
	UpdateMask *google_protobuf4.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"`
}

Request for `UpdateDeviceRegistry`.

func (*UpdateDeviceRegistryRequest) Descriptor 

func (*UpdateDeviceRegistryRequest) Descriptor() ([]byte, []int)

func (*UpdateDeviceRegistryRequest) GetDeviceRegistry 

func (m *UpdateDeviceRegistryRequest) GetDeviceRegistry() *DeviceRegistry

func (*UpdateDeviceRegistryRequest) GetUpdateMask 

func (m *UpdateDeviceRegistryRequest) GetUpdateMask() *google_protobuf4.FieldMask

func (*UpdateDeviceRegistryRequest) ProtoMessage 

func (*UpdateDeviceRegistryRequest) ProtoMessage()

func (*UpdateDeviceRegistryRequest) Reset 

func (m *UpdateDeviceRegistryRequest) Reset()

func (*UpdateDeviceRegistryRequest) String 

func (m *UpdateDeviceRegistryRequest) String() string

type UpdateDeviceRequest 

type UpdateDeviceRequest struct {
	// The new values for the device registry. The `id` and `num_id` fields must
	// be empty, and the field `name` must specify the name path. For example,
	// `projects/p0/locations/us-central1/registries/registry0/devices/device0`or
	// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
	Device *Device `protobuf:"bytes,2,opt,name=device" json:"device,omitempty"`
	// Only updates the `device` fields indicated by this mask.
	// The field mask must not be empty, and it must not contain fields that
	// are immutable or only set by the server.
	// Mutable top-level fields: `credentials`, `enabled_state`, and `metadata`
	UpdateMask *google_protobuf4.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"`
}

Request for `UpdateDevice`.

func (*UpdateDeviceRequest) Descriptor 

func (*UpdateDeviceRequest) Descriptor() ([]byte, []int)

func (*UpdateDeviceRequest) GetDevice 

func (m *UpdateDeviceRequest) GetDevice() *Device

func (*UpdateDeviceRequest) GetUpdateMask 

func (m *UpdateDeviceRequest) GetUpdateMask() *google_protobuf4.FieldMask

func (*UpdateDeviceRequest) ProtoMessage 

func (*UpdateDeviceRequest) ProtoMessage()

func (*UpdateDeviceRequest) Reset 

func (m *UpdateDeviceRequest) Reset()

func (*UpdateDeviceRequest) String 

func (m *UpdateDeviceRequest) String() string

type X509CertificateDetails 

type X509CertificateDetails struct {
	// The entity that signed the certificate.
	Issuer string `protobuf:"bytes,1,opt,name=issuer" json:"issuer,omitempty"`
	// The entity the certificate and public key belong to.
	Subject string `protobuf:"bytes,2,opt,name=subject" json:"subject,omitempty"`
	// The time the certificate becomes valid.
	StartTime *google_protobuf1.Timestamp `protobuf:"bytes,3,opt,name=start_time,json=startTime" json:"start_time,omitempty"`
	// The time the certificate becomes invalid.
	ExpiryTime *google_protobuf1.Timestamp `protobuf:"bytes,4,opt,name=expiry_time,json=expiryTime" json:"expiry_time,omitempty"`
	// The algorithm used to sign the certificate.
	SignatureAlgorithm string `protobuf:"bytes,5,opt,name=signature_algorithm,json=signatureAlgorithm" json:"signature_algorithm,omitempty"`
	// The type of public key in the certificate.
	PublicKeyType string `protobuf:"bytes,6,opt,name=public_key_type,json=publicKeyType" json:"public_key_type,omitempty"`
}

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

func (*X509CertificateDetails) Descriptor 

func (*X509CertificateDetails) Descriptor() ([]byte, []int)

func (*X509CertificateDetails) GetExpiryTime 

func (m *X509CertificateDetails) GetExpiryTime() *google_protobuf1.Timestamp

func (*X509CertificateDetails) GetIssuer 

func (m *X509CertificateDetails) GetIssuer() string

func (*X509CertificateDetails) GetPublicKeyType 

func (m *X509CertificateDetails) GetPublicKeyType() string

func (*X509CertificateDetails) GetSignatureAlgorithm 

func (m *X509CertificateDetails) GetSignatureAlgorithm() string

func (*X509CertificateDetails) GetStartTime 

func (m *X509CertificateDetails) GetStartTime() *google_protobuf1.Timestamp

func (*X509CertificateDetails) GetSubject 

func (m *X509CertificateDetails) GetSubject() string

func (*X509CertificateDetails) ProtoMessage 

func (*X509CertificateDetails) ProtoMessage()

func (*X509CertificateDetails) Reset 

func (m *X509CertificateDetails) Reset()

func (*X509CertificateDetails) String 

func (m *X509CertificateDetails) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.