Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	MqttState_name = map[int32]string{
		0: "MQTT_STATE_UNSPECIFIED",
		1: "MQTT_ENABLED",
		2: "MQTT_DISABLED",
	}
	MqttState_value = map[string]int32{
		"MQTT_STATE_UNSPECIFIED": 0,
		"MQTT_ENABLED":           1,
		"MQTT_DISABLED":          2,
	}
)

Enum value maps for MqttState.

View Source
var (
	HttpState_name = map[int32]string{
		0: "HTTP_STATE_UNSPECIFIED",
		1: "HTTP_ENABLED",
		2: "HTTP_DISABLED",
	}
	HttpState_value = map[string]int32{
		"HTTP_STATE_UNSPECIFIED": 0,
		"HTTP_ENABLED":           1,
		"HTTP_DISABLED":          2,
	}
)

Enum value maps for HttpState.

View Source
var (
	LogLevel_name = map[int32]string{
		0:  "LOG_LEVEL_UNSPECIFIED",
		10: "NONE",
		20: "ERROR",
		30: "INFO",
		40: "DEBUG",
	}
	LogLevel_value = map[string]int32{
		"LOG_LEVEL_UNSPECIFIED": 0,
		"NONE":                  10,
		"ERROR":                 20,
		"INFO":                  30,
		"DEBUG":                 40,
	}
)

Enum value maps for LogLevel.

View Source
var (
	GatewayType_name = map[int32]string{
		0: "GATEWAY_TYPE_UNSPECIFIED",
		1: "GATEWAY",
		2: "NON_GATEWAY",
	}
	GatewayType_value = map[string]int32{
		"GATEWAY_TYPE_UNSPECIFIED": 0,
		"GATEWAY":                  1,
		"NON_GATEWAY":              2,
	}
)

Enum value maps for GatewayType.

View Source
var (
	GatewayAuthMethod_name = map[int32]string{
		0: "GATEWAY_AUTH_METHOD_UNSPECIFIED",
		1: "ASSOCIATION_ONLY",
		2: "DEVICE_AUTH_TOKEN_ONLY",
		3: "ASSOCIATION_AND_DEVICE_AUTH_TOKEN",
	}
	GatewayAuthMethod_value = map[string]int32{
		"GATEWAY_AUTH_METHOD_UNSPECIFIED":   0,
		"ASSOCIATION_ONLY":                  1,
		"DEVICE_AUTH_TOKEN_ONLY":            2,
		"ASSOCIATION_AND_DEVICE_AUTH_TOKEN": 3,
	}
)

Enum value maps for GatewayAuthMethod.

View Source
var (
	PublicKeyCertificateFormat_name = map[int32]string{
		0: "UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT",
		1: "X509_CERTIFICATE_PEM",
	}
	PublicKeyCertificateFormat_value = map[string]int32{
		"UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT": 0,
		"X509_CERTIFICATE_PEM":                      1,
	}
)

Enum value maps for PublicKeyCertificateFormat.

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",
	}
	PublicKeyFormat_value = map[string]int32{
		"UNSPECIFIED_PUBLIC_KEY_FORMAT": 0,
		"RSA_PEM":                       3,
		"RSA_X509_PEM":                  1,
		"ES256_PEM":                     2,
		"ES256_X509_PEM":                4,
	}
)

Enum value maps for PublicKeyFormat.

View Source
var File_google_cloud_iot_v1_device_manager_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_iot_v1_resources_proto protoreflect.FileDescriptor

Functions

func RegisterDeviceManagerServer

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

Types

type BindDeviceToGatewayRequest

type BindDeviceToGatewayRequest struct {

	// Required. The name of the registry. For example,
	// `projects/example-project/locations/us-central1/registries/my-registry`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The value of `gateway_id` can be either the device numeric ID or the
	// user-defined device identifier.
	GatewayId string `protobuf:"bytes,2,opt,name=gateway_id,json=gatewayId,proto3" json:"gateway_id,omitempty"`
	// Required. The device to associate with the specified gateway. The value of
	// `device_id` can be either the device numeric ID or the user-defined device
	// identifier.
	DeviceId string `protobuf:"bytes,3,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// contains filtered or unexported fields
}

Request for `BindDeviceToGateway`.

func (*BindDeviceToGatewayRequest) Descriptor

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

Deprecated: Use BindDeviceToGatewayRequest.ProtoReflect.Descriptor instead.

func (*BindDeviceToGatewayRequest) GetDeviceId

func (x *BindDeviceToGatewayRequest) GetDeviceId() string

func (*BindDeviceToGatewayRequest) GetGatewayId

func (x *BindDeviceToGatewayRequest) GetGatewayId() string

func (*BindDeviceToGatewayRequest) GetParent

func (x *BindDeviceToGatewayRequest) GetParent() string

func (*BindDeviceToGatewayRequest) ProtoMessage

func (*BindDeviceToGatewayRequest) ProtoMessage()

func (*BindDeviceToGatewayRequest) ProtoReflect

func (*BindDeviceToGatewayRequest) Reset

func (x *BindDeviceToGatewayRequest) Reset()

func (*BindDeviceToGatewayRequest) String

func (x *BindDeviceToGatewayRequest) String() string

type BindDeviceToGatewayResponse

type BindDeviceToGatewayResponse struct {
	// contains filtered or unexported fields
}

Response for `BindDeviceToGateway`.

func (*BindDeviceToGatewayResponse) Descriptor

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

Deprecated: Use BindDeviceToGatewayResponse.ProtoReflect.Descriptor instead.

func (*BindDeviceToGatewayResponse) ProtoMessage

func (*BindDeviceToGatewayResponse) ProtoMessage()

func (*BindDeviceToGatewayResponse) ProtoReflect

func (*BindDeviceToGatewayResponse) Reset

func (x *BindDeviceToGatewayResponse) Reset()

func (*BindDeviceToGatewayResponse) String

func (x *BindDeviceToGatewayResponse) String() string

type CreateDeviceRegistryRequest

type CreateDeviceRegistryRequest struct {

	// Required. 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,proto3" json:"parent,omitempty"`
	// Required. 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,proto3" json:"device_registry,omitempty"`
	// contains filtered or unexported fields
}

Request for `CreateDeviceRegistry`.

func (*CreateDeviceRegistryRequest) Descriptor

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

Deprecated: Use CreateDeviceRegistryRequest.ProtoReflect.Descriptor instead.

func (*CreateDeviceRegistryRequest) GetDeviceRegistry

func (x *CreateDeviceRegistryRequest) GetDeviceRegistry() *DeviceRegistry

func (*CreateDeviceRegistryRequest) GetParent

func (x *CreateDeviceRegistryRequest) GetParent() string

func (*CreateDeviceRegistryRequest) ProtoMessage

func (*CreateDeviceRegistryRequest) ProtoMessage()

func (*CreateDeviceRegistryRequest) ProtoReflect

func (*CreateDeviceRegistryRequest) Reset

func (x *CreateDeviceRegistryRequest) Reset()

func (*CreateDeviceRegistryRequest) String

func (x *CreateDeviceRegistryRequest) String() string

type CreateDeviceRequest

type CreateDeviceRequest struct {

	// Required. 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,proto3" json:"parent,omitempty"`
	// Required. The device registration details. The field `name` must be empty. The server
	// generates `name` from the device registry `id` and the
	// `parent` field.
	Device *Device `protobuf:"bytes,2,opt,name=device,proto3" json:"device,omitempty"`
	// contains filtered or unexported fields
}

Request for `CreateDevice`.

func (*CreateDeviceRequest) Descriptor

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

Deprecated: Use CreateDeviceRequest.ProtoReflect.Descriptor instead.

func (*CreateDeviceRequest) GetDevice

func (x *CreateDeviceRequest) GetDevice() *Device

func (*CreateDeviceRequest) GetParent

func (x *CreateDeviceRequest) GetParent() string

func (*CreateDeviceRequest) ProtoMessage

func (*CreateDeviceRequest) ProtoMessage()

func (*CreateDeviceRequest) ProtoReflect

func (x *CreateDeviceRequest) ProtoReflect() protoreflect.Message

func (*CreateDeviceRequest) Reset

func (x *CreateDeviceRequest) Reset()

func (*CreateDeviceRequest) String

func (x *CreateDeviceRequest) String() string

type DeleteDeviceRegistryRequest

type DeleteDeviceRegistryRequest struct {

	// Required. 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,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for `DeleteDeviceRegistry`.

func (*DeleteDeviceRegistryRequest) Descriptor

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

Deprecated: Use DeleteDeviceRegistryRequest.ProtoReflect.Descriptor instead.

func (*DeleteDeviceRegistryRequest) GetName

func (x *DeleteDeviceRegistryRequest) GetName() string

func (*DeleteDeviceRegistryRequest) ProtoMessage

func (*DeleteDeviceRegistryRequest) ProtoMessage()

func (*DeleteDeviceRegistryRequest) ProtoReflect

func (*DeleteDeviceRegistryRequest) Reset

func (x *DeleteDeviceRegistryRequest) Reset()

func (*DeleteDeviceRegistryRequest) String

func (x *DeleteDeviceRegistryRequest) String() string

type DeleteDeviceRequest

type DeleteDeviceRequest struct {

	// Required. 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,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for `DeleteDevice`.

func (*DeleteDeviceRequest) Descriptor

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

Deprecated: Use DeleteDeviceRequest.ProtoReflect.Descriptor instead.

func (*DeleteDeviceRequest) GetName

func (x *DeleteDeviceRequest) GetName() string

func (*DeleteDeviceRequest) ProtoMessage

func (*DeleteDeviceRequest) ProtoMessage()

func (*DeleteDeviceRequest) ProtoReflect

func (x *DeleteDeviceRequest) ProtoReflect() protoreflect.Message

func (*DeleteDeviceRequest) Reset

func (x *DeleteDeviceRequest) Reset()

func (*DeleteDeviceRequest) String

func (x *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,proto3" 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,proto3" 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,proto3" 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,proto3" json:"credentials,omitempty"`
	// [Output only] The last time an MQTT `PINGREQ` was received. This field
	// applies only to devices connecting through MQTT. MQTT clients usually only
	// send `PINGREQ` messages if the connection is idle, and no other messages
	// have been sent. Timestamps are periodically collected and written to
	// storage; they may be stale by a few minutes.
	LastHeartbeatTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=last_heartbeat_time,json=lastHeartbeatTime,proto3" 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 *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=last_event_time,json=lastEventTime,proto3" 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 *timestamppb.Timestamp `protobuf:"bytes,20,opt,name=last_state_time,json=lastStateTime,proto3" 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 *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=last_config_ack_time,json=lastConfigAckTime,proto3" json:"last_config_ack_time,omitempty"`
	// [Output only] The last time a cloud-to-device config version was sent to
	// the device.
	LastConfigSendTime *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=last_config_send_time,json=lastConfigSendTime,proto3" 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,proto3" 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 *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=last_error_time,json=lastErrorTime,proto3" 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 *status.Status `protobuf:"bytes,11,opt,name=last_error_status,json=lastErrorStatus,proto3" 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,proto3" 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,proto3" json:"state,omitempty"`
	// **Beta Feature**
	//
	// The logging verbosity for device activity. If unspecified,
	// DeviceRegistry.log_level will be used.
	LogLevel LogLevel `protobuf:"varint,21,opt,name=log_level,json=logLevel,proto3,enum=google.cloud.iot.v1.LogLevel" json:"log_level,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-Z][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 `` /* 158-byte string literal not displayed */
	// Gateway-related configuration and state.
	GatewayConfig *GatewayConfig `protobuf:"bytes,24,opt,name=gateway_config,json=gatewayConfig,proto3" json:"gateway_config,omitempty"`
	// contains filtered or unexported fields
}

The device resource.

func (*Device) Descriptor

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

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetBlocked

func (x *Device) GetBlocked() bool

func (*Device) GetConfig

func (x *Device) GetConfig() *DeviceConfig

func (*Device) GetCredentials

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

func (*Device) GetGatewayConfig

func (x *Device) GetGatewayConfig() *GatewayConfig

func (*Device) GetId

func (x *Device) GetId() string

func (*Device) GetLastConfigAckTime

func (x *Device) GetLastConfigAckTime() *timestamppb.Timestamp

func (*Device) GetLastConfigSendTime

func (x *Device) GetLastConfigSendTime() *timestamppb.Timestamp

func (*Device) GetLastErrorStatus

func (x *Device) GetLastErrorStatus() *status.Status

func (*Device) GetLastErrorTime

func (x *Device) GetLastErrorTime() *timestamppb.Timestamp

func (*Device) GetLastEventTime

func (x *Device) GetLastEventTime() *timestamppb.Timestamp

func (*Device) GetLastHeartbeatTime

func (x *Device) GetLastHeartbeatTime() *timestamppb.Timestamp

func (*Device) GetLastStateTime

func (x *Device) GetLastStateTime() *timestamppb.Timestamp

func (*Device) GetLogLevel

func (x *Device) GetLogLevel() LogLevel

func (*Device) GetMetadata

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

func (*Device) GetName

func (x *Device) GetName() string

func (*Device) GetNumId

func (x *Device) GetNumId() uint64

func (*Device) GetState

func (x *Device) GetState() *DeviceState

func (*Device) ProtoMessage

func (*Device) ProtoMessage()

func (*Device) ProtoReflect

func (x *Device) ProtoReflect() protoreflect.Message

func (*Device) Reset

func (x *Device) Reset()

func (*Device) String

func (x *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,proto3" 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 *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=cloud_update_time,json=cloudUpdateTime,proto3" 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 *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=device_ack_time,json=deviceAckTime,proto3" 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"`
	// contains filtered or unexported fields
}

The device configuration. Eventually delivered to devices.

func (*DeviceConfig) Descriptor

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

Deprecated: Use DeviceConfig.ProtoReflect.Descriptor instead.

func (*DeviceConfig) GetBinaryData

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

func (*DeviceConfig) GetCloudUpdateTime

func (x *DeviceConfig) GetCloudUpdateTime() *timestamppb.Timestamp

func (*DeviceConfig) GetDeviceAckTime

func (x *DeviceConfig) GetDeviceAckTime() *timestamppb.Timestamp

func (*DeviceConfig) GetVersion

func (x *DeviceConfig) GetVersion() int64

func (*DeviceConfig) ProtoMessage

func (*DeviceConfig) ProtoMessage()

func (*DeviceConfig) ProtoReflect

func (x *DeviceConfig) ProtoReflect() protoreflect.Message

func (*DeviceConfig) Reset

func (x *DeviceConfig) Reset()

func (*DeviceConfig) String

func (x *DeviceConfig) String() string

type DeviceCredential

type DeviceCredential struct {

	// The credential data. Reserved for expansion in the future.
	//
	// Types that are assignable 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 *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=expiration_time,json=expirationTime,proto3" json:"expiration_time,omitempty"`
	// contains filtered or unexported fields
}

A server-stored device credential used for authentication.

func (*DeviceCredential) Descriptor

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

Deprecated: Use DeviceCredential.ProtoReflect.Descriptor instead.

func (*DeviceCredential) GetCredential

func (m *DeviceCredential) GetCredential() isDeviceCredential_Credential

func (*DeviceCredential) GetExpirationTime

func (x *DeviceCredential) GetExpirationTime() *timestamppb.Timestamp

func (*DeviceCredential) GetPublicKey

func (x *DeviceCredential) GetPublicKey() *PublicKeyCredential

func (*DeviceCredential) ProtoMessage

func (*DeviceCredential) ProtoMessage()

func (*DeviceCredential) ProtoReflect

func (x *DeviceCredential) ProtoReflect() protoreflect.Message

func (*DeviceCredential) Reset

func (x *DeviceCredential) Reset()

func (*DeviceCredential) String

func (x *DeviceCredential) String() string

type DeviceCredential_PublicKey

type DeviceCredential_PublicKey struct {
	// A public key used to verify the signature of JSON Web Tokens (JWTs).
	// When adding a new device credential, either via device creation or via
	// modifications, this public key credential may be required to be signed by
	// one of the registry level certificates. More specifically, if the
	// registry contains at least one certificate, any new device credential
	// must be signed by one of the registry certificates. As a result,
	// when the registry contains certificates, only X.509 certificates are
	// accepted as device credentials. However, if the registry does
	// not contain a certificate, self-signed certificates and public keys will
	// be accepted. New device credentials must be different from every
	// registry-level certificate.
	PublicKey *PublicKeyCredential `protobuf:"bytes,2,opt,name=public_key,json=publicKey,proto3,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) (*emptypb.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) (*emptypb.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 *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*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 *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*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 *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.TestIamPermissionsResponse, error)
	// Sends a command to the specified device. In order for a device to be able
	// to receive commands, it must:
	// 1) be connected to Cloud IoT Core using the MQTT protocol, and
	// 2) be subscribed to the group of MQTT topics specified by
	//    /devices/{device-id}/commands/#. This subscription will receive commands
	//    at the top-level topic /devices/{device-id}/commands as well as commands
	//    for subfolders, like /devices/{device-id}/commands/subfolder.
	//    Note that subscribing to specific subfolders is not supported.
	// If the command could not be delivered to the device, this method will
	// return an error; in particular, if the device is not subscribed, this
	// method will return FAILED_PRECONDITION. Otherwise, this method will
	// return OK. If the subscription is QoS 1, at least once delivery will be
	// guaranteed; for QoS 0, no acknowledgment will be expected from the device.
	SendCommandToDevice(ctx context.Context, in *SendCommandToDeviceRequest, opts ...grpc.CallOption) (*SendCommandToDeviceResponse, error)
	// Associates the device with the gateway.
	BindDeviceToGateway(ctx context.Context, in *BindDeviceToGatewayRequest, opts ...grpc.CallOption) (*BindDeviceToGatewayResponse, error)
	// Deletes the association between the device and the gateway.
	UnbindDeviceFromGateway(ctx context.Context, in *UnbindDeviceFromGatewayRequest, opts ...grpc.CallOption) (*UnbindDeviceFromGatewayResponse, error)
}

DeviceManagerClient is the client API for DeviceManager service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

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) (*emptypb.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) (*emptypb.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, *v1.SetIamPolicyRequest) (*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, *v1.GetIamPolicyRequest) (*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, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
	// Sends a command to the specified device. In order for a device to be able
	// to receive commands, it must:
	// 1) be connected to Cloud IoT Core using the MQTT protocol, and
	// 2) be subscribed to the group of MQTT topics specified by
	//    /devices/{device-id}/commands/#. This subscription will receive commands
	//    at the top-level topic /devices/{device-id}/commands as well as commands
	//    for subfolders, like /devices/{device-id}/commands/subfolder.
	//    Note that subscribing to specific subfolders is not supported.
	// If the command could not be delivered to the device, this method will
	// return an error; in particular, if the device is not subscribed, this
	// method will return FAILED_PRECONDITION. Otherwise, this method will
	// return OK. If the subscription is QoS 1, at least once delivery will be
	// guaranteed; for QoS 0, no acknowledgment will be expected from the device.
	SendCommandToDevice(context.Context, *SendCommandToDeviceRequest) (*SendCommandToDeviceResponse, error)
	// Associates the device with the gateway.
	BindDeviceToGateway(context.Context, *BindDeviceToGatewayRequest) (*BindDeviceToGatewayResponse, error)
	// Deletes the association between the device and the gateway.
	UnbindDeviceFromGateway(context.Context, *UnbindDeviceFromGatewayRequest) (*UnbindDeviceFromGatewayResponse, error)
}

DeviceManagerServer is the server API for DeviceManager service.

type DeviceRegistry

type DeviceRegistry struct {

	// The identifier of this device registry. For example, `myRegistry`.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" 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,proto3" 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. If multiple configurations match a message,
	// only the first matching 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. Up to 10
	// configurations may be provided.
	EventNotificationConfigs []*EventNotificationConfig `` /* 136-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 `` /* 132-byte string literal not displayed */
	// The MQTT configuration for this device registry.
	MqttConfig *MqttConfig `protobuf:"bytes,4,opt,name=mqtt_config,json=mqttConfig,proto3" json:"mqtt_config,omitempty"`
	// The DeviceService (HTTP) configuration for this device registry.
	HttpConfig *HttpConfig `protobuf:"bytes,9,opt,name=http_config,json=httpConfig,proto3" json:"http_config,omitempty"`
	// **Beta Feature**
	//
	// The default logging verbosity for activity from devices in this registry.
	// The verbosity level can be overridden by Device.log_level.
	LogLevel LogLevel `protobuf:"varint,11,opt,name=log_level,json=logLevel,proto3,enum=google.cloud.iot.v1.LogLevel" json:"log_level,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,proto3" json:"credentials,omitempty"`
	// contains filtered or unexported fields
}

A container for a group of devices.

func (*DeviceRegistry) Descriptor

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

Deprecated: Use DeviceRegistry.ProtoReflect.Descriptor instead.

func (*DeviceRegistry) GetCredentials

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

func (*DeviceRegistry) GetEventNotificationConfigs

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

func (*DeviceRegistry) GetHttpConfig

func (x *DeviceRegistry) GetHttpConfig() *HttpConfig

func (*DeviceRegistry) GetId

func (x *DeviceRegistry) GetId() string

func (*DeviceRegistry) GetLogLevel

func (x *DeviceRegistry) GetLogLevel() LogLevel

func (*DeviceRegistry) GetMqttConfig

func (x *DeviceRegistry) GetMqttConfig() *MqttConfig

func (*DeviceRegistry) GetName

func (x *DeviceRegistry) GetName() string

func (*DeviceRegistry) GetStateNotificationConfig

func (x *DeviceRegistry) GetStateNotificationConfig() *StateNotificationConfig

func (*DeviceRegistry) ProtoMessage

func (*DeviceRegistry) ProtoMessage()

func (*DeviceRegistry) ProtoReflect

func (x *DeviceRegistry) ProtoReflect() protoreflect.Message

func (*DeviceRegistry) Reset

func (x *DeviceRegistry) Reset()

func (*DeviceRegistry) String

func (x *DeviceRegistry) String() string

type DeviceState

type DeviceState struct {

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

The device state, as reported by the device.

func (*DeviceState) Descriptor

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

Deprecated: Use DeviceState.ProtoReflect.Descriptor instead.

func (*DeviceState) GetBinaryData

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

func (*DeviceState) GetUpdateTime

func (x *DeviceState) GetUpdateTime() *timestamppb.Timestamp

func (*DeviceState) ProtoMessage

func (*DeviceState) ProtoMessage()

func (*DeviceState) ProtoReflect

func (x *DeviceState) ProtoReflect() protoreflect.Message

func (*DeviceState) Reset

func (x *DeviceState) Reset()

func (*DeviceState) String

func (x *DeviceState) String() string

type EventNotificationConfig

type EventNotificationConfig struct {

	// If the subfolder name matches this string exactly, this configuration will
	// be used. The string must not include the leading '/' character. If empty,
	// all strings are matched. This field is used only for telemetry events;
	// subfolders are not supported for state changes.
	SubfolderMatches string `protobuf:"bytes,2,opt,name=subfolder_matches,json=subfolderMatches,proto3" json:"subfolder_matches,omitempty"`
	// A Cloud Pub/Sub topic name. For example,
	// `projects/myProject/topics/deviceEvents`.
	PubsubTopicName string `protobuf:"bytes,1,opt,name=pubsub_topic_name,json=pubsubTopicName,proto3" json:"pubsub_topic_name,omitempty"`
	// contains filtered or unexported fields
}

The configuration for forwarding telemetry events.

func (*EventNotificationConfig) Descriptor

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

Deprecated: Use EventNotificationConfig.ProtoReflect.Descriptor instead.

func (*EventNotificationConfig) GetPubsubTopicName

func (x *EventNotificationConfig) GetPubsubTopicName() string

func (*EventNotificationConfig) GetSubfolderMatches

func (x *EventNotificationConfig) GetSubfolderMatches() string

func (*EventNotificationConfig) ProtoMessage

func (*EventNotificationConfig) ProtoMessage()

func (*EventNotificationConfig) ProtoReflect

func (x *EventNotificationConfig) ProtoReflect() protoreflect.Message

func (*EventNotificationConfig) Reset

func (x *EventNotificationConfig) Reset()

func (*EventNotificationConfig) String

func (x *EventNotificationConfig) String() string

type GatewayAuthMethod

type GatewayAuthMethod int32

The gateway authorization/authentication method. This setting determines how Cloud IoT Core authorizes/authenticate devices to access the gateway.

const (
	// No authentication/authorization method specified. No devices are allowed to
	// access the gateway.
	GatewayAuthMethod_GATEWAY_AUTH_METHOD_UNSPECIFIED GatewayAuthMethod = 0
	// The device is authenticated through the gateway association only. Device
	// credentials are ignored even if provided.
	GatewayAuthMethod_ASSOCIATION_ONLY GatewayAuthMethod = 1
	// The device is authenticated through its own credentials. Gateway
	// association is not checked.
	GatewayAuthMethod_DEVICE_AUTH_TOKEN_ONLY GatewayAuthMethod = 2
	// The device is authenticated through both device credentials and gateway
	// association. The device must be bound to the gateway and must provide its
	// own credentials.
	GatewayAuthMethod_ASSOCIATION_AND_DEVICE_AUTH_TOKEN GatewayAuthMethod = 3
)

func (GatewayAuthMethod) Descriptor

func (GatewayAuthMethod) Enum

func (GatewayAuthMethod) EnumDescriptor

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

Deprecated: Use GatewayAuthMethod.Descriptor instead.

func (GatewayAuthMethod) Number

func (GatewayAuthMethod) String

func (x GatewayAuthMethod) String() string

func (GatewayAuthMethod) Type

type GatewayConfig

type GatewayConfig struct {

	// Indicates whether the device is a gateway.
	GatewayType GatewayType `` /* 132-byte string literal not displayed */
	// Indicates how to authorize and/or authenticate devices to access the
	// gateway.
	GatewayAuthMethod GatewayAuthMethod `` /* 158-byte string literal not displayed */
	// [Output only] The ID of the gateway the device accessed most recently.
	LastAccessedGatewayId string `` /* 128-byte string literal not displayed */
	// [Output only] The most recent time at which the device accessed the gateway
	// specified in `last_accessed_gateway`.
	LastAccessedGatewayTime *timestamppb.Timestamp `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

Gateway-related configuration and state.

func (*GatewayConfig) Descriptor

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

Deprecated: Use GatewayConfig.ProtoReflect.Descriptor instead.

func (*GatewayConfig) GetGatewayAuthMethod

func (x *GatewayConfig) GetGatewayAuthMethod() GatewayAuthMethod

func (*GatewayConfig) GetGatewayType

func (x *GatewayConfig) GetGatewayType() GatewayType

func (*GatewayConfig) GetLastAccessedGatewayId

func (x *GatewayConfig) GetLastAccessedGatewayId() string

func (*GatewayConfig) GetLastAccessedGatewayTime

func (x *GatewayConfig) GetLastAccessedGatewayTime() *timestamppb.Timestamp

func (*GatewayConfig) ProtoMessage

func (*GatewayConfig) ProtoMessage()

func (*GatewayConfig) ProtoReflect

func (x *GatewayConfig) ProtoReflect() protoreflect.Message

func (*GatewayConfig) Reset

func (x *GatewayConfig) Reset()

func (*GatewayConfig) String

func (x *GatewayConfig) String() string

type GatewayListOptions

type GatewayListOptions struct {

	// If not set, all devices and gateways are returned. If set, the list is
	// filtered based on gateway type and associations.
	//
	// Types that are assignable to Filter:
	//	*GatewayListOptions_GatewayType
	//	*GatewayListOptions_AssociationsGatewayId
	//	*GatewayListOptions_AssociationsDeviceId
	Filter isGatewayListOptions_Filter `protobuf_oneof:"filter"`
	// contains filtered or unexported fields
}

Options for limiting the list based on gateway type and associations.

func (*GatewayListOptions) Descriptor

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

Deprecated: Use GatewayListOptions.ProtoReflect.Descriptor instead.

func (*GatewayListOptions) GetAssociationsDeviceId

func (x *GatewayListOptions) GetAssociationsDeviceId() string

func (*GatewayListOptions) GetAssociationsGatewayId

func (x *GatewayListOptions) GetAssociationsGatewayId() string

func (*GatewayListOptions) GetFilter

func (m *GatewayListOptions) GetFilter() isGatewayListOptions_Filter

func (*GatewayListOptions) GetGatewayType

func (x *GatewayListOptions) GetGatewayType() GatewayType

func (*GatewayListOptions) ProtoMessage

func (*GatewayListOptions) ProtoMessage()

func (*GatewayListOptions) ProtoReflect

func (x *GatewayListOptions) ProtoReflect() protoreflect.Message

func (*GatewayListOptions) Reset

func (x *GatewayListOptions) Reset()

func (*GatewayListOptions) String

func (x *GatewayListOptions) String() string

type GatewayListOptions_AssociationsDeviceId

type GatewayListOptions_AssociationsDeviceId struct {
	// If set, returns only the gateways with which the specified device is
	// associated. The device ID can be numeric (`num_id`) or the user-defined
	// string (`id`). For example, if `456` is specified, returns only the
	// gateways to which the device with `num_id` 456 is bound.
	AssociationsDeviceId string `protobuf:"bytes,3,opt,name=associations_device_id,json=associationsDeviceId,proto3,oneof"`
}

type GatewayListOptions_AssociationsGatewayId

type GatewayListOptions_AssociationsGatewayId struct {
	// If set, only devices associated with the specified gateway are returned.
	// The gateway ID can be numeric (`num_id`) or the user-defined string
	// (`id`). For example, if `123` is specified, only devices bound to the
	// gateway with `num_id` 123 are returned.
	AssociationsGatewayId string `protobuf:"bytes,2,opt,name=associations_gateway_id,json=associationsGatewayId,proto3,oneof"`
}

type GatewayListOptions_GatewayType

type GatewayListOptions_GatewayType struct {
	// If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY`
	// is specified, only non-gateway devices are returned. If
	// `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.
	GatewayType GatewayType `protobuf:"varint,1,opt,name=gateway_type,json=gatewayType,proto3,enum=google.cloud.iot.v1.GatewayType,oneof"`
}

type GatewayType

type GatewayType int32

Gateway type.

const (
	// If unspecified, the device is considered a non-gateway device.
	GatewayType_GATEWAY_TYPE_UNSPECIFIED GatewayType = 0
	// The device is a gateway.
	GatewayType_GATEWAY GatewayType = 1
	// The device is not a gateway.
	GatewayType_NON_GATEWAY GatewayType = 2
)

func (GatewayType) Descriptor

func (GatewayType) Enum

func (x GatewayType) Enum() *GatewayType

func (GatewayType) EnumDescriptor

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

Deprecated: Use GatewayType.Descriptor instead.

func (GatewayType) Number

func (x GatewayType) Number() protoreflect.EnumNumber

func (GatewayType) String

func (x GatewayType) String() string

func (GatewayType) Type

type GetDeviceRegistryRequest

type GetDeviceRegistryRequest struct {

	// Required. 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,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for `GetDeviceRegistry`.

func (*GetDeviceRegistryRequest) Descriptor

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

Deprecated: Use GetDeviceRegistryRequest.ProtoReflect.Descriptor instead.

func (*GetDeviceRegistryRequest) GetName

func (x *GetDeviceRegistryRequest) GetName() string

func (*GetDeviceRegistryRequest) ProtoMessage

func (*GetDeviceRegistryRequest) ProtoMessage()

func (*GetDeviceRegistryRequest) ProtoReflect

func (x *GetDeviceRegistryRequest) ProtoReflect() protoreflect.Message

func (*GetDeviceRegistryRequest) Reset

func (x *GetDeviceRegistryRequest) Reset()

func (*GetDeviceRegistryRequest) String

func (x *GetDeviceRegistryRequest) String() string

type GetDeviceRequest

type GetDeviceRequest struct {

	// Required. 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,proto3" 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 *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for `GetDevice`.

func (*GetDeviceRequest) Descriptor

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

Deprecated: Use GetDeviceRequest.ProtoReflect.Descriptor instead.

func (*GetDeviceRequest) GetFieldMask

func (x *GetDeviceRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*GetDeviceRequest) GetName

func (x *GetDeviceRequest) GetName() string

func (*GetDeviceRequest) ProtoMessage

func (*GetDeviceRequest) ProtoMessage()

func (*GetDeviceRequest) ProtoReflect

func (x *GetDeviceRequest) ProtoReflect() protoreflect.Message

func (*GetDeviceRequest) Reset

func (x *GetDeviceRequest) Reset()

func (*GetDeviceRequest) String

func (x *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 `` /* 147-byte string literal not displayed */
	// contains filtered or unexported fields
}

The configuration of the HTTP bridge for a device registry.

func (*HttpConfig) Descriptor

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

Deprecated: Use HttpConfig.ProtoReflect.Descriptor instead.

func (*HttpConfig) GetHttpEnabledState

func (x *HttpConfig) GetHttpEnabledState() HttpState

func (*HttpConfig) ProtoMessage

func (*HttpConfig) ProtoMessage()

func (*HttpConfig) ProtoReflect

func (x *HttpConfig) ProtoReflect() protoreflect.Message

func (*HttpConfig) Reset

func (x *HttpConfig) Reset()

func (*HttpConfig) String

func (x *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) Descriptor

func (HttpState) Descriptor() protoreflect.EnumDescriptor

func (HttpState) Enum

func (x HttpState) Enum() *HttpState

func (HttpState) EnumDescriptor

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

Deprecated: Use HttpState.Descriptor instead.

func (HttpState) Number

func (x HttpState) Number() protoreflect.EnumNumber

func (HttpState) String

func (x HttpState) String() string

func (HttpState) Type

type ListDeviceConfigVersionsRequest

type ListDeviceConfigVersionsRequest struct {

	// Required. 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,proto3" 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,proto3" json:"num_versions,omitempty"`
	// contains filtered or unexported fields
}

Request for `ListDeviceConfigVersions`.

func (*ListDeviceConfigVersionsRequest) Descriptor

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

Deprecated: Use ListDeviceConfigVersionsRequest.ProtoReflect.Descriptor instead.

func (*ListDeviceConfigVersionsRequest) GetName

func (*ListDeviceConfigVersionsRequest) GetNumVersions

func (x *ListDeviceConfigVersionsRequest) GetNumVersions() int32

func (*ListDeviceConfigVersionsRequest) ProtoMessage

func (*ListDeviceConfigVersionsRequest) ProtoMessage()

func (*ListDeviceConfigVersionsRequest) ProtoReflect

func (*ListDeviceConfigVersionsRequest) Reset

func (*ListDeviceConfigVersionsRequest) 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,proto3" json:"device_configs,omitempty"`
	// contains filtered or unexported fields
}

Response for `ListDeviceConfigVersions`.

func (*ListDeviceConfigVersionsResponse) Descriptor

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

Deprecated: Use ListDeviceConfigVersionsResponse.ProtoReflect.Descriptor instead.

func (*ListDeviceConfigVersionsResponse) GetDeviceConfigs

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

func (*ListDeviceConfigVersionsResponse) ProtoMessage

func (*ListDeviceConfigVersionsResponse) ProtoMessage()

func (*ListDeviceConfigVersionsResponse) ProtoReflect

func (*ListDeviceConfigVersionsResponse) Reset

func (*ListDeviceConfigVersionsResponse) String

type ListDeviceRegistriesRequest

type ListDeviceRegistriesRequest struct {

	// Required. The project and cloud region path. For example,
	// `projects/example-project/locations/us-central1`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" 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. A non-empty `next_page_token` in the response
	// indicates that more data is available.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The value returned by the last `ListDeviceRegistriesResponse`; indicates
	// that this is a continuation of a prior `ListDeviceRegistries` call and
	// the system should return the next page of data.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for `ListDeviceRegistries`.

func (*ListDeviceRegistriesRequest) Descriptor

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

Deprecated: Use ListDeviceRegistriesRequest.ProtoReflect.Descriptor instead.

func (*ListDeviceRegistriesRequest) GetPageSize

func (x *ListDeviceRegistriesRequest) GetPageSize() int32

func (*ListDeviceRegistriesRequest) GetPageToken

func (x *ListDeviceRegistriesRequest) GetPageToken() string

func (*ListDeviceRegistriesRequest) GetParent

func (x *ListDeviceRegistriesRequest) GetParent() string

func (*ListDeviceRegistriesRequest) ProtoMessage

func (*ListDeviceRegistriesRequest) ProtoMessage()

func (*ListDeviceRegistriesRequest) ProtoReflect

func (*ListDeviceRegistriesRequest) Reset

func (x *ListDeviceRegistriesRequest) Reset()

func (*ListDeviceRegistriesRequest) String

func (x *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,proto3" 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,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for `ListDeviceRegistries`.

func (*ListDeviceRegistriesResponse) Descriptor

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

Deprecated: Use ListDeviceRegistriesResponse.ProtoReflect.Descriptor instead.

func (*ListDeviceRegistriesResponse) GetDeviceRegistries

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

func (*ListDeviceRegistriesResponse) GetNextPageToken

func (x *ListDeviceRegistriesResponse) GetNextPageToken() string

func (*ListDeviceRegistriesResponse) ProtoMessage

func (*ListDeviceRegistriesResponse) ProtoMessage()

func (*ListDeviceRegistriesResponse) ProtoReflect

func (*ListDeviceRegistriesResponse) Reset

func (x *ListDeviceRegistriesResponse) Reset()

func (*ListDeviceRegistriesResponse) String

type ListDeviceStatesRequest

type ListDeviceStatesRequest struct {

	// Required. 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,proto3" 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,proto3" json:"num_states,omitempty"`
	// contains filtered or unexported fields
}

Request for `ListDeviceStates`.

func (*ListDeviceStatesRequest) Descriptor

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

Deprecated: Use ListDeviceStatesRequest.ProtoReflect.Descriptor instead.

func (*ListDeviceStatesRequest) GetName

func (x *ListDeviceStatesRequest) GetName() string

func (*ListDeviceStatesRequest) GetNumStates

func (x *ListDeviceStatesRequest) GetNumStates() int32

func (*ListDeviceStatesRequest) ProtoMessage

func (*ListDeviceStatesRequest) ProtoMessage()

func (*ListDeviceStatesRequest) ProtoReflect

func (x *ListDeviceStatesRequest) ProtoReflect() protoreflect.Message

func (*ListDeviceStatesRequest) Reset

func (x *ListDeviceStatesRequest) Reset()

func (*ListDeviceStatesRequest) String

func (x *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,proto3" json:"device_states,omitempty"`
	// contains filtered or unexported fields
}

Response for `ListDeviceStates`.

func (*ListDeviceStatesResponse) Descriptor

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

Deprecated: Use ListDeviceStatesResponse.ProtoReflect.Descriptor instead.

func (*ListDeviceStatesResponse) GetDeviceStates

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

func (*ListDeviceStatesResponse) ProtoMessage

func (*ListDeviceStatesResponse) ProtoMessage()

func (*ListDeviceStatesResponse) ProtoReflect

func (x *ListDeviceStatesResponse) ProtoReflect() protoreflect.Message

func (*ListDeviceStatesResponse) Reset

func (x *ListDeviceStatesResponse) Reset()

func (*ListDeviceStatesResponse) String

func (x *ListDeviceStatesResponse) String() string

type ListDevicesRequest

type ListDevicesRequest struct {

	// Required. The device registry path. Required. For example,
	// `projects/my-project/locations/us-central1/registries/my-registry`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// A list of device numeric IDs. If empty, this field is ignored. Maximum
	// IDs: 10,000.
	DeviceNumIds []uint64 `protobuf:"varint,2,rep,packed,name=device_num_ids,json=deviceNumIds,proto3" json:"device_num_ids,omitempty"`
	// A list of device string IDs. For example, `['device0', 'device12']`.
	// If empty, this field is ignored. Maximum IDs: 10,000
	DeviceIds []string `protobuf:"bytes,3,rep,name=device_ids,json=deviceIds,proto3" 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, along with any
	// other fields specified.
	FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// Options related to gateways.
	GatewayListOptions *GatewayListOptions `protobuf:"bytes,6,opt,name=gateway_list_options,json=gatewayListOptions,proto3" json:"gateway_list_options,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. A non-empty `next_page_token` in the response
	// indicates that more data is available.
	PageSize int32 `protobuf:"varint,100,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The value returned by the last `ListDevicesResponse`; indicates
	// that this is a continuation of a prior `ListDevices` call and
	// the system should return the next page of data.
	PageToken string `protobuf:"bytes,101,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for `ListDevices`.

func (*ListDevicesRequest) Descriptor

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

Deprecated: Use ListDevicesRequest.ProtoReflect.Descriptor instead.

func (*ListDevicesRequest) GetDeviceIds

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

func (*ListDevicesRequest) GetDeviceNumIds

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

func (*ListDevicesRequest) GetFieldMask

func (x *ListDevicesRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*ListDevicesRequest) GetGatewayListOptions

func (x *ListDevicesRequest) GetGatewayListOptions() *GatewayListOptions

func (*ListDevicesRequest) GetPageSize

func (x *ListDevicesRequest) GetPageSize() int32

func (*ListDevicesRequest) GetPageToken

func (x *ListDevicesRequest) GetPageToken() string

func (*ListDevicesRequest) GetParent

func (x *ListDevicesRequest) GetParent() string

func (*ListDevicesRequest) ProtoMessage

func (*ListDevicesRequest) ProtoMessage()

func (*ListDevicesRequest) ProtoReflect

func (x *ListDevicesRequest) ProtoReflect() protoreflect.Message

func (*ListDevicesRequest) Reset

func (x *ListDevicesRequest) Reset()

func (*ListDevicesRequest) String

func (x *ListDevicesRequest) String() string

type ListDevicesResponse

type ListDevicesResponse struct {

	// The devices that match the request.
	Devices []*Device `protobuf:"bytes,1,rep,name=devices,proto3" 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,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for `ListDevices`.

func (*ListDevicesResponse) Descriptor

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

Deprecated: Use ListDevicesResponse.ProtoReflect.Descriptor instead.

func (*ListDevicesResponse) GetDevices

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

func (*ListDevicesResponse) GetNextPageToken

func (x *ListDevicesResponse) GetNextPageToken() string

func (*ListDevicesResponse) ProtoMessage

func (*ListDevicesResponse) ProtoMessage()

func (*ListDevicesResponse) ProtoReflect

func (x *ListDevicesResponse) ProtoReflect() protoreflect.Message

func (*ListDevicesResponse) Reset

func (x *ListDevicesResponse) Reset()

func (*ListDevicesResponse) String

func (x *ListDevicesResponse) String() string

type LogLevel

type LogLevel int32

**Beta Feature**

The logging verbosity for device activity. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging.

const (
	// No logging specified. If not specified, logging will be disabled.
	LogLevel_LOG_LEVEL_UNSPECIFIED LogLevel = 0
	// Disables logging.
	LogLevel_NONE LogLevel = 10
	// Error events will be logged.
	LogLevel_ERROR LogLevel = 20
	// Informational events will be logged, such as connections and
	// disconnections.
	LogLevel_INFO LogLevel = 30
	// All events will be logged.
	LogLevel_DEBUG LogLevel = 40
)

func (LogLevel) Descriptor

func (LogLevel) Descriptor() protoreflect.EnumDescriptor

func (LogLevel) Enum

func (x LogLevel) Enum() *LogLevel

func (LogLevel) EnumDescriptor

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

Deprecated: Use LogLevel.Descriptor instead.

func (LogLevel) Number

func (x LogLevel) Number() protoreflect.EnumNumber

func (LogLevel) String

func (x LogLevel) String() string

func (LogLevel) Type

type ModifyCloudToDeviceConfigRequest

type ModifyCloudToDeviceConfigRequest struct {

	// Required. 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,proto3" 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,proto3" json:"version_to_update,omitempty"`
	// Required. The configuration data for the device.
	BinaryData []byte `protobuf:"bytes,3,opt,name=binary_data,json=binaryData,proto3" json:"binary_data,omitempty"`
	// contains filtered or unexported fields
}

Request for `ModifyCloudToDeviceConfig`.

func (*ModifyCloudToDeviceConfigRequest) Descriptor

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

Deprecated: Use ModifyCloudToDeviceConfigRequest.ProtoReflect.Descriptor instead.

func (*ModifyCloudToDeviceConfigRequest) GetBinaryData

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

func (*ModifyCloudToDeviceConfigRequest) GetName

func (*ModifyCloudToDeviceConfigRequest) GetVersionToUpdate

func (x *ModifyCloudToDeviceConfigRequest) GetVersionToUpdate() int64

func (*ModifyCloudToDeviceConfigRequest) ProtoMessage

func (*ModifyCloudToDeviceConfigRequest) ProtoMessage()

func (*ModifyCloudToDeviceConfigRequest) ProtoReflect

func (*ModifyCloudToDeviceConfigRequest) Reset

func (*ModifyCloudToDeviceConfigRequest) String

type MqttConfig

type MqttConfig struct {

	// If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
	// connections to this registry will fail.
	MqttEnabledState MqttState `` /* 147-byte string literal not displayed */
	// contains filtered or unexported fields
}

The configuration of MQTT for a device registry.

func (*MqttConfig) Descriptor

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

Deprecated: Use MqttConfig.ProtoReflect.Descriptor instead.

func (*MqttConfig) GetMqttEnabledState

func (x *MqttConfig) GetMqttEnabledState() MqttState

func (*MqttConfig) ProtoMessage

func (*MqttConfig) ProtoMessage()

func (*MqttConfig) ProtoReflect

func (x *MqttConfig) ProtoReflect() protoreflect.Message

func (*MqttConfig) Reset

func (x *MqttConfig) Reset()

func (*MqttConfig) String

func (x *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) Descriptor

func (MqttState) Descriptor() protoreflect.EnumDescriptor

func (MqttState) Enum

func (x MqttState) Enum() *MqttState

func (MqttState) EnumDescriptor

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

Deprecated: Use MqttState.Descriptor instead.

func (MqttState) Number

func (x MqttState) Number() protoreflect.EnumNumber

func (MqttState) String

func (x MqttState) String() string

func (MqttState) Type

type PublicKeyCertificate

type PublicKeyCertificate struct {

	// The certificate format.
	Format PublicKeyCertificateFormat `protobuf:"varint,1,opt,name=format,proto3,enum=google.cloud.iot.v1.PublicKeyCertificateFormat" json:"format,omitempty"`
	// The certificate data.
	Certificate string `protobuf:"bytes,2,opt,name=certificate,proto3" 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,proto3" json:"x509_details,omitempty"`
	// contains filtered or unexported fields
}

A public key certificate format and data.

func (*PublicKeyCertificate) Descriptor

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

Deprecated: Use PublicKeyCertificate.ProtoReflect.Descriptor instead.

func (*PublicKeyCertificate) GetCertificate

func (x *PublicKeyCertificate) GetCertificate() string

func (*PublicKeyCertificate) GetFormat

func (*PublicKeyCertificate) GetX509Details

func (x *PublicKeyCertificate) GetX509Details() *X509CertificateDetails

func (*PublicKeyCertificate) ProtoMessage

func (*PublicKeyCertificate) ProtoMessage()

func (*PublicKeyCertificate) ProtoReflect

func (x *PublicKeyCertificate) ProtoReflect() protoreflect.Message

func (*PublicKeyCertificate) Reset

func (x *PublicKeyCertificate) Reset()

func (*PublicKeyCertificate) String

func (x *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) Descriptor

func (PublicKeyCertificateFormat) Enum

func (PublicKeyCertificateFormat) EnumDescriptor

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

Deprecated: Use PublicKeyCertificateFormat.Descriptor instead.

func (PublicKeyCertificateFormat) Number

func (PublicKeyCertificateFormat) String

func (PublicKeyCertificateFormat) Type

type PublicKeyCredential

type PublicKeyCredential struct {

	// The format of the key.
	Format PublicKeyFormat `protobuf:"varint,1,opt,name=format,proto3,enum=google.cloud.iot.v1.PublicKeyFormat" json:"format,omitempty"`
	// The key data.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

A public key format and data.

func (*PublicKeyCredential) Descriptor

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

Deprecated: Use PublicKeyCredential.ProtoReflect.Descriptor instead.

func (*PublicKeyCredential) GetFormat

func (x *PublicKeyCredential) GetFormat() PublicKeyFormat

func (*PublicKeyCredential) GetKey

func (x *PublicKeyCredential) GetKey() string

func (*PublicKeyCredential) ProtoMessage

func (*PublicKeyCredential) ProtoMessage()

func (*PublicKeyCredential) ProtoReflect

func (x *PublicKeyCredential) ProtoReflect() protoreflect.Message

func (*PublicKeyCredential) Reset

func (x *PublicKeyCredential) Reset()

func (*PublicKeyCredential) String

func (x *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) Descriptor

func (PublicKeyFormat) Enum

func (x PublicKeyFormat) Enum() *PublicKeyFormat

func (PublicKeyFormat) EnumDescriptor

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

Deprecated: Use PublicKeyFormat.Descriptor instead.

func (PublicKeyFormat) Number

func (PublicKeyFormat) String

func (x PublicKeyFormat) String() string

func (PublicKeyFormat) Type

type RegistryCredential

type RegistryCredential struct {

	// The credential data. Reserved for expansion in the future.
	//
	// Types that are assignable to Credential:
	//	*RegistryCredential_PublicKeyCertificate
	Credential isRegistryCredential_Credential `protobuf_oneof:"credential"`
	// contains filtered or unexported fields
}

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

func (*RegistryCredential) Descriptor

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

Deprecated: Use RegistryCredential.ProtoReflect.Descriptor instead.

func (*RegistryCredential) GetCredential

func (m *RegistryCredential) GetCredential() isRegistryCredential_Credential

func (*RegistryCredential) GetPublicKeyCertificate

func (x *RegistryCredential) GetPublicKeyCertificate() *PublicKeyCertificate

func (*RegistryCredential) ProtoMessage

func (*RegistryCredential) ProtoMessage()

func (*RegistryCredential) ProtoReflect

func (x *RegistryCredential) ProtoReflect() protoreflect.Message

func (*RegistryCredential) Reset

func (x *RegistryCredential) Reset()

func (*RegistryCredential) String

func (x *RegistryCredential) String() string

type RegistryCredential_PublicKeyCertificate

type RegistryCredential_PublicKeyCertificate struct {
	// A public key certificate used to verify the device credentials.
	PublicKeyCertificate *PublicKeyCertificate `protobuf:"bytes,1,opt,name=public_key_certificate,json=publicKeyCertificate,proto3,oneof"`
}

type SendCommandToDeviceRequest

type SendCommandToDeviceRequest struct {

	// Required. 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,proto3" json:"name,omitempty"`
	// Required. The command data to send to the device.
	BinaryData []byte `protobuf:"bytes,2,opt,name=binary_data,json=binaryData,proto3" json:"binary_data,omitempty"`
	// Optional subfolder for the command. If empty, the command will be delivered
	// to the /devices/{device-id}/commands topic, otherwise it will be delivered
	// to the /devices/{device-id}/commands/{subfolder} topic. Multi-level
	// subfolders are allowed. This field must not have more than 256 characters,
	// and must not contain any MQTT wildcards ("+" or "#") or null characters.
	Subfolder string `protobuf:"bytes,3,opt,name=subfolder,proto3" json:"subfolder,omitempty"`
	// contains filtered or unexported fields
}

Request for `SendCommandToDevice`.

func (*SendCommandToDeviceRequest) Descriptor

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

Deprecated: Use SendCommandToDeviceRequest.ProtoReflect.Descriptor instead.

func (*SendCommandToDeviceRequest) GetBinaryData

func (x *SendCommandToDeviceRequest) GetBinaryData() []byte

func (*SendCommandToDeviceRequest) GetName

func (x *SendCommandToDeviceRequest) GetName() string

func (*SendCommandToDeviceRequest) GetSubfolder

func (x *SendCommandToDeviceRequest) GetSubfolder() string

func (*SendCommandToDeviceRequest) ProtoMessage

func (*SendCommandToDeviceRequest) ProtoMessage()

func (*SendCommandToDeviceRequest) ProtoReflect

func (*SendCommandToDeviceRequest) Reset

func (x *SendCommandToDeviceRequest) Reset()

func (*SendCommandToDeviceRequest) String

func (x *SendCommandToDeviceRequest) String() string

type SendCommandToDeviceResponse

type SendCommandToDeviceResponse struct {
	// contains filtered or unexported fields
}

Response for `SendCommandToDevice`.

func (*SendCommandToDeviceResponse) Descriptor

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

Deprecated: Use SendCommandToDeviceResponse.ProtoReflect.Descriptor instead.

func (*SendCommandToDeviceResponse) ProtoMessage

func (*SendCommandToDeviceResponse) ProtoMessage()

func (*SendCommandToDeviceResponse) ProtoReflect

func (*SendCommandToDeviceResponse) Reset

func (x *SendCommandToDeviceResponse) Reset()

func (*SendCommandToDeviceResponse) String

func (x *SendCommandToDeviceResponse) String() string

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,proto3" json:"pubsub_topic_name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*StateNotificationConfig) Descriptor

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

Deprecated: Use StateNotificationConfig.ProtoReflect.Descriptor instead.

func (*StateNotificationConfig) GetPubsubTopicName

func (x *StateNotificationConfig) GetPubsubTopicName() string

func (*StateNotificationConfig) ProtoMessage

func (*StateNotificationConfig) ProtoMessage()

func (*StateNotificationConfig) ProtoReflect

func (x *StateNotificationConfig) ProtoReflect() protoreflect.Message

func (*StateNotificationConfig) Reset

func (x *StateNotificationConfig) Reset()

func (*StateNotificationConfig) String

func (x *StateNotificationConfig) String() string

type UnbindDeviceFromGatewayRequest

type UnbindDeviceFromGatewayRequest struct {

	// Required. The name of the registry. For example,
	// `projects/example-project/locations/us-central1/registries/my-registry`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The value of `gateway_id` can be either the device numeric ID or the
	// user-defined device identifier.
	GatewayId string `protobuf:"bytes,2,opt,name=gateway_id,json=gatewayId,proto3" json:"gateway_id,omitempty"`
	// Required. The device to disassociate from the specified gateway. The value of
	// `device_id` can be either the device numeric ID or the user-defined device
	// identifier.
	DeviceId string `protobuf:"bytes,3,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// contains filtered or unexported fields
}

Request for `UnbindDeviceFromGateway`.

func (*UnbindDeviceFromGatewayRequest) Descriptor

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

Deprecated: Use UnbindDeviceFromGatewayRequest.ProtoReflect.Descriptor instead.

func (*UnbindDeviceFromGatewayRequest) GetDeviceId

func (x *UnbindDeviceFromGatewayRequest) GetDeviceId() string

func (*UnbindDeviceFromGatewayRequest) GetGatewayId

func (x *UnbindDeviceFromGatewayRequest) GetGatewayId() string

func (*UnbindDeviceFromGatewayRequest) GetParent

func (x *UnbindDeviceFromGatewayRequest) GetParent() string

func (*UnbindDeviceFromGatewayRequest) ProtoMessage

func (*UnbindDeviceFromGatewayRequest) ProtoMessage()

func (*UnbindDeviceFromGatewayRequest) ProtoReflect

func (*UnbindDeviceFromGatewayRequest) Reset

func (x *UnbindDeviceFromGatewayRequest) Reset()

func (*UnbindDeviceFromGatewayRequest) String

type UnbindDeviceFromGatewayResponse

type UnbindDeviceFromGatewayResponse struct {
	// contains filtered or unexported fields
}

Response for `UnbindDeviceFromGateway`.

func (*UnbindDeviceFromGatewayResponse) Descriptor

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

Deprecated: Use UnbindDeviceFromGatewayResponse.ProtoReflect.Descriptor instead.

func (*UnbindDeviceFromGatewayResponse) ProtoMessage

func (*UnbindDeviceFromGatewayResponse) ProtoMessage()

func (*UnbindDeviceFromGatewayResponse) ProtoReflect

func (*UnbindDeviceFromGatewayResponse) Reset

func (*UnbindDeviceFromGatewayResponse) String

type UnimplementedDeviceManagerServer

type UnimplementedDeviceManagerServer struct {
}

UnimplementedDeviceManagerServer can be embedded to have forward compatible implementations.

func (*UnimplementedDeviceManagerServer) BindDeviceToGateway

func (*UnimplementedDeviceManagerServer) CreateDevice

func (*UnimplementedDeviceManagerServer) CreateDeviceRegistry

func (*UnimplementedDeviceManagerServer) DeleteDevice

func (*UnimplementedDeviceManagerServer) DeleteDeviceRegistry

func (*UnimplementedDeviceManagerServer) GetDevice

func (*UnimplementedDeviceManagerServer) GetDeviceRegistry

func (*UnimplementedDeviceManagerServer) GetIamPolicy

func (*UnimplementedDeviceManagerServer) ListDeviceStates

func (*UnimplementedDeviceManagerServer) ListDevices

func (*UnimplementedDeviceManagerServer) ModifyCloudToDeviceConfig

func (*UnimplementedDeviceManagerServer) SendCommandToDevice

func (*UnimplementedDeviceManagerServer) SetIamPolicy

func (*UnimplementedDeviceManagerServer) TestIamPermissions

func (*UnimplementedDeviceManagerServer) UpdateDevice

func (*UnimplementedDeviceManagerServer) UpdateDeviceRegistry

type UpdateDeviceRegistryRequest

type UpdateDeviceRegistryRequest struct {

	// Required. 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,proto3" json:"device_registry,omitempty"`
	// Required. 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 *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for `UpdateDeviceRegistry`.

func (*UpdateDeviceRegistryRequest) Descriptor

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

Deprecated: Use UpdateDeviceRegistryRequest.ProtoReflect.Descriptor instead.

func (*UpdateDeviceRegistryRequest) GetDeviceRegistry

func (x *UpdateDeviceRegistryRequest) GetDeviceRegistry() *DeviceRegistry

func (*UpdateDeviceRegistryRequest) GetUpdateMask

func (*UpdateDeviceRegistryRequest) ProtoMessage

func (*UpdateDeviceRegistryRequest) ProtoMessage()

func (*UpdateDeviceRegistryRequest) ProtoReflect

func (*UpdateDeviceRegistryRequest) Reset

func (x *UpdateDeviceRegistryRequest) Reset()

func (*UpdateDeviceRegistryRequest) String

func (x *UpdateDeviceRegistryRequest) String() string

type UpdateDeviceRequest

type UpdateDeviceRequest struct {

	// Required. The new values for the device. 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,proto3" json:"device,omitempty"`
	// Required. 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`, `blocked`, and `metadata`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for `UpdateDevice`.

func (*UpdateDeviceRequest) Descriptor

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

Deprecated: Use UpdateDeviceRequest.ProtoReflect.Descriptor instead.

func (*UpdateDeviceRequest) GetDevice

func (x *UpdateDeviceRequest) GetDevice() *Device

func (*UpdateDeviceRequest) GetUpdateMask

func (x *UpdateDeviceRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDeviceRequest) ProtoMessage

func (*UpdateDeviceRequest) ProtoMessage()

func (*UpdateDeviceRequest) ProtoReflect

func (x *UpdateDeviceRequest) ProtoReflect() protoreflect.Message

func (*UpdateDeviceRequest) Reset

func (x *UpdateDeviceRequest) Reset()

func (*UpdateDeviceRequest) String

func (x *UpdateDeviceRequest) String() string

type X509CertificateDetails

type X509CertificateDetails struct {

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

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

func (*X509CertificateDetails) Descriptor

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

Deprecated: Use X509CertificateDetails.ProtoReflect.Descriptor instead.

func (*X509CertificateDetails) GetExpiryTime

func (x *X509CertificateDetails) GetExpiryTime() *timestamppb.Timestamp

func (*X509CertificateDetails) GetIssuer

func (x *X509CertificateDetails) GetIssuer() string

func (*X509CertificateDetails) GetPublicKeyType

func (x *X509CertificateDetails) GetPublicKeyType() string

func (*X509CertificateDetails) GetSignatureAlgorithm

func (x *X509CertificateDetails) GetSignatureAlgorithm() string

func (*X509CertificateDetails) GetStartTime

func (x *X509CertificateDetails) GetStartTime() *timestamppb.Timestamp

func (*X509CertificateDetails) GetSubject

func (x *X509CertificateDetails) GetSubject() string

func (*X509CertificateDetails) ProtoMessage

func (*X509CertificateDetails) ProtoMessage()

func (*X509CertificateDetails) ProtoReflect

func (x *X509CertificateDetails) ProtoReflect() protoreflect.Message

func (*X509CertificateDetails) Reset

func (x *X509CertificateDetails) Reset()

func (*X509CertificateDetails) String

func (x *X509CertificateDetails) String() string