pb

package
v2.14.0 Latest Latest
Warning

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

Go to latest
Published: Nov 18, 2023 License: Apache-2.0 Imports: 26 Imported by: 3

README

Protocol Documentation

Table of Contents

Top

grpc-gateway/pb/cancelCommands.proto

CancelPendingCommandsRequest
Field Type Label Description
resource_id resourceaggregate.pb.ResourceId
correlation_id_filter string repeated empty array means all.

CancelPendingCommandsResponse
Field Type Label Description
correlation_ids string repeated

CancelPendingMetadataUpdatesRequest
Field Type Label Description
device_id string
correlation_id_filter string repeated

Top

grpc-gateway/pb/devices.proto

Content
Field Type Label Description
content_type string
data bytes

CreateResourceRequest
Field Type Label Description
resource_id resourceaggregate.pb.ResourceId
content Content
time_to_live int64 command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).

CreateResourceResponse
Field Type Label Description
data resourceaggregate.pb.ResourceCreated

DeleteDevicesRequest
Field Type Label Description
device_id_filter string repeated

DeleteDevicesResponse
Field Type Label Description
device_ids string repeated

DeleteResourceRequest
Field Type Label Description
resource_id resourceaggregate.pb.ResourceId
time_to_live int64 command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).
resource_interface string

DeleteResourceResponse
Field Type Label Description
data resourceaggregate.pb.ResourceDeleted

Device
Field Type Label Description
id string
types string repeated
name string
metadata Device.Metadata
manufacturer_name LocalizedString repeated
model_number string
interfaces string repeated
protocol_independent_id string
data resourceaggregate.pb.ResourceChanged
ownership_status Device.OwnershipStatus ownership status of the device
endpoints string repeated endpoints with schemas which are hosted by the device

Device.Metadata
Field Type Label Description
connection resourceaggregate.pb.Connection
twin_synchronization resourceaggregate.pb.TwinSynchronization
twin_enabled bool

Event
Field Type Label Description
subscription_id string subscription id provided by grpc
correlation_id string
device_registered Event.DeviceRegistered
device_unregistered Event.DeviceUnregistered
resource_published resourceaggregate.pb.ResourceLinksPublished
resource_unpublished resourceaggregate.pb.ResourceLinksUnpublished
resource_changed resourceaggregate.pb.ResourceChanged
operation_processed Event.OperationProcessed
subscription_canceled Event.SubscriptionCanceled
resource_update_pending resourceaggregate.pb.ResourceUpdatePending
resource_updated resourceaggregate.pb.ResourceUpdated
resource_retrieve_pending resourceaggregate.pb.ResourceRetrievePending
resource_retrieved resourceaggregate.pb.ResourceRetrieved
resource_delete_pending resourceaggregate.pb.ResourceDeletePending
resource_deleted resourceaggregate.pb.ResourceDeleted
resource_create_pending resourceaggregate.pb.ResourceCreatePending
resource_created resourceaggregate.pb.ResourceCreated
device_metadata_update_pending resourceaggregate.pb.DeviceMetadataUpdatePending
device_metadata_updated resourceaggregate.pb.DeviceMetadataUpdated

Event.DeviceRegistered
Field Type Label Description
device_ids string repeated
event_metadata identitystore.pb.EventMetadata provides metadata of event
open_telemetry_carrier Event.DeviceRegistered.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

Event.DeviceRegistered.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

Event.DeviceUnregistered
Field Type Label Description
device_ids string repeated
event_metadata identitystore.pb.EventMetadata provides metadata of event
open_telemetry_carrier Event.DeviceUnregistered.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

Event.DeviceUnregistered.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

Event.OperationProcessed
Field Type Label Description
error_status Event.OperationProcessed.ErrorStatus

Event.OperationProcessed.ErrorStatus
Field Type Label Description
code Event.OperationProcessed.ErrorStatus.Code
message string

Event.SubscriptionCanceled
Field Type Label Description
reason string

GetDevicesRequest
Field Type Label Description
type_filter string repeated
status_filter GetDevicesRequest.Status repeated
device_id_filter string repeated

GetResourceFromDeviceRequest
Field Type Label Description
resource_id resourceaggregate.pb.ResourceId
resource_interface string
time_to_live int64 command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).
etag bytes repeated optional

GetResourceFromDeviceResponse
Field Type Label Description
data resourceaggregate.pb.ResourceRetrieved

GetResourceLinksRequest
Field Type Label Description
type_filter string repeated
device_id_filter string repeated

GetResourcesRequest
Field Type Label Description
http_resource_id_filter string repeated Deprecated. Format: {deviceID}{href}(?etag=abc), e.g., "ae424c58-e517-4494-6de7-583536c48213/oic/d?etag=abc"
device_id_filter string repeated Filter devices by deviceID
type_filter string repeated Filter devices by resource types in the oic/d resource
resource_id_filter ResourceIdFilter repeated New resource ID filter. For HTTP requests, use it multiple times as a query parameter like "resourceIdFilter={deviceID}{href}(?etag=abc)"

LocalizedString
Field Type Label Description
language string
value string

Resource
Field Type Label Description
types string repeated
data resourceaggregate.pb.ResourceChanged

ResourceIdFilter
Field Type Label Description
resource_id resourceaggregate.pb.ResourceId Filter specific resources
etag bytes repeated Optional; resource_id.{deviceId, href} must not be empty

SubscribeToEvents
Field Type Label Description
create_subscription SubscribeToEvents.CreateSubscription
cancel_subscription SubscribeToEvents.CancelSubscription
correlation_id string for pairing request SubscribeToEvents with Event.OperationProcessed

SubscribeToEvents.CancelSubscription
Field Type Label Description
subscription_id string

SubscribeToEvents.CreateSubscription

If you want to subscribe to all events, leave the filter unset. Use the event_filter in conjunction with other filters to filter events by type. If event_filter is set, only events with the specified type will be received. To filter devices, use the device_id_filter. It follows the format {deviceID[0]+"/"+"", deviceID[1]+"/"+"", ...}. To filter resources, use the href_filter. It follows the format {""+href[0], ""+href[1], ...}. When both device_id_filter and href_filter are set, the href_filter is applied to each device. {deviceID[0]+href[0], ..., deviceID[1]+href[0], ...}. To filter resources of specific devices, use the resource_id_filter. You can use either device_id_filter or resource_id_filter or both. In this case, the result is the union of both filters. Certain filters perform a logical "or" operation among the elements of the filter.

Field Type Label Description
event_filter SubscribeToEvents.CreateSubscription.Event repeated array of events. eg: [ REGISTERED, UNREGISTERED ]
device_id_filter string repeated array of format {deviceID}. eg [ "ae424c58-e517-4494-6de7-583536c48213" ]
http_resource_id_filter string repeated Deprecated. array of format {deviceID}{href}. eg [ "ae424c58-e517-4494-6de7-583536c48213/oic/d", "ae424c58-e517-4494-6de7-583536c48213/oic/p" ]
href_filter string repeated array of format {href}. eg [ "/oic/d", "/oic/p" ]
resource_id_filter ResourceIdFilter repeated

UpdateResourceRequest
Field Type Label Description
resource_id resourceaggregate.pb.ResourceId
resource_interface string
time_to_live int64 command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).
content Content

UpdateResourceResponse
Field Type Label Description
data resourceaggregate.pb.ResourceUpdated

Device.OwnershipStatus
Name Number Description
UNKNOWN 0 cannot determine ownership status
UNOWNED 1 device is ready to be owned the user
OWNED 2 device is owned by the user. to determine who own the device you need to get ownership resource /oic/sec/doxm
UNSUPPORTED 3 set when device is not secured. (iotivity-lite was built without security)

Event.OperationProcessed.ErrorStatus.Code
Name Number Description
OK 0
ERROR 1
NOT_FOUND 2

GetDevicesRequest.Status
Name Number Description
ONLINE 0
OFFLINE 1

SubscribeToEvents.CreateSubscription.Event
Name Number Description
REGISTERED 0
UNREGISTERED 1
DEVICE_METADATA_UPDATED 4
DEVICE_METADATA_UPDATE_PENDING 5
RESOURCE_PUBLISHED 6
RESOURCE_UNPUBLISHED 7
RESOURCE_UPDATE_PENDING 8
RESOURCE_UPDATED 9
RESOURCE_RETRIEVE_PENDING 10
RESOURCE_RETRIEVED 11
RESOURCE_DELETE_PENDING 12
RESOURCE_DELETED 13
RESOURCE_CREATE_PENDING 14
RESOURCE_CREATED 15
RESOURCE_CHANGED 16

Top

grpc-gateway/pb/events.proto

GetEventsRequest
Field Type Label Description
device_id_filter string repeated
http_resource_id_filter string repeated Deprecated. format {deviceID}{href}. eg "ae424c58-e517-4494-6de7-583536c48213/oic/d"
timestamp_filter int64 filter events with timestamp > than given value
resource_id_filter ResourceIdFilter repeated New resource ID filter. For HTTP requests, use it multiple times as a query parameter like "resourceIdFilter={deviceID}{href}".

GetEventsResponse
Field Type Label Description
resource_links_published resourceaggregate.pb.ResourceLinksPublished
resource_links_unpublished resourceaggregate.pb.ResourceLinksUnpublished
resource_links_snapshot_taken resourceaggregate.pb.ResourceLinksSnapshotTaken
resource_changed resourceaggregate.pb.ResourceChanged
resource_update_pending resourceaggregate.pb.ResourceUpdatePending
resource_updated resourceaggregate.pb.ResourceUpdated
resource_retrieve_pending resourceaggregate.pb.ResourceRetrievePending
resource_retrieved resourceaggregate.pb.ResourceRetrieved
resource_delete_pending resourceaggregate.pb.ResourceDeletePending
resource_deleted resourceaggregate.pb.ResourceDeleted
resource_create_pending resourceaggregate.pb.ResourceCreatePending
resource_created resourceaggregate.pb.ResourceCreated
resource_state_snapshot_taken resourceaggregate.pb.ResourceStateSnapshotTaken
device_metadata_update_pending resourceaggregate.pb.DeviceMetadataUpdatePending
device_metadata_updated resourceaggregate.pb.DeviceMetadataUpdated
device_metadata_snapshot_taken resourceaggregate.pb.DeviceMetadataSnapshotTaken

Top

grpc-gateway/pb/getDevicesMetadata.proto

GetDevicesMetadataRequest
Field Type Label Description
device_id_filter string repeated
type_filter string repeated

Top

grpc-gateway/pb/getPendingCommands.proto

GetPendingCommandsRequest
Field Type Label Description
command_filter GetPendingCommandsRequest.Command repeated
http_resource_id_filter string repeated Deprecated.
device_id_filter string repeated
type_filter string repeated
resource_id_filter ResourceIdFilter repeated New resource ID filter. For HTTP requests, use it multiple times as a query parameter like "resourceIdFilter={deviceID}{href}".

PendingCommand
Field Type Label Description
resource_create_pending resourceaggregate.pb.ResourceCreatePending
resource_retrieve_pending resourceaggregate.pb.ResourceRetrievePending
resource_update_pending resourceaggregate.pb.ResourceUpdatePending
resource_delete_pending resourceaggregate.pb.ResourceDeletePending
device_metadata_update_pending resourceaggregate.pb.DeviceMetadataUpdatePending

GetPendingCommandsRequest.Command
Name Number Description
RESOURCE_CREATE 0
RESOURCE_RETRIEVE 1
RESOURCE_UPDATE 2
RESOURCE_DELETE 3
DEVICE_METADATA_UPDATE 4

Top

grpc-gateway/pb/hubConfiguration.proto

BuildInfo
Field Type Label Description
version string version of the service
build_date string build date of the service
commit_hash string commit hash of the service
commit_date string commit date of the service
release_url string release url of the service

DeviceOAuthClient
Field Type Label Description
client_id string @gotags: yaml:"clientID"
audience string
scopes string repeated
provider_name string @gotags: yaml:"providerName"

HubConfigurationRequest

HubConfigurationResponse
Field Type Label Description
current_time int64 provides a current time of server in nanoseconds.
jwt_owner_claim string
jwt_device_id_claim string
id string
coap_gateway string
certificate_authorities string
authority string
default_command_time_to_live int64 exposes default command time to live in nanoseconds for CreateResource, RetrieveResource, UpdateResource, DeleteResource, and UpdateDeviceMetadata commands when it is not set in the request. 0 - means forever.
certificate_authority string certificate_authority in format https://host:port
http_gateway_address string cfg for UI http-gateway
web_oauth_client WebOAuthClient
device_oauth_client DeviceOAuthClient
build_info BuildInfo build info

WebOAuthClient
Field Type Label Description
client_id string @gotags: yaml:"clientID"
audience string
scopes string repeated

Top

grpc-gateway/pb/service.proto

GrpcGateway
Method Name Request Type Response Type Description
GetDevices GetDevicesRequest Device stream Get all devices
DeleteDevices DeleteDevicesRequest DeleteDevicesResponse Delete selected devices.
GetResourceLinks GetResourceLinksRequest .resourceaggregate.pb.ResourceLinksPublished stream Get resource links of devices.
GetResourceFromDevice GetResourceFromDeviceRequest GetResourceFromDeviceResponse Get resource from the device.
GetResources GetResourcesRequest Resource stream Get resources from the resource shadow.
UpdateResource UpdateResourceRequest UpdateResourceResponse Update resource at the device.
SubscribeToEvents SubscribeToEvents stream Event stream When the client creates a subscription. Subscription doesn't guarantee that all events will be sent to the client. The client is responsible for synchronize events.
GetHubConfiguration HubConfigurationRequest HubConfigurationResponse Get cloud configuration
DeleteResource DeleteResourceRequest DeleteResourceResponse Delete resource at the device.
CreateResource CreateResourceRequest CreateResourceResponse Create resource at the device.
UpdateDeviceMetadata UpdateDeviceMetadataRequest UpdateDeviceMetadataResponse Enables/disables shadow synchronization for device.
GetPendingCommands GetPendingCommandsRequest PendingCommand stream Gets pending commands for devices .
CancelPendingCommands CancelPendingCommandsRequest CancelPendingCommandsResponse Cancels resource commands.
CancelPendingMetadataUpdates CancelPendingMetadataUpdatesRequest CancelPendingCommandsResponse Cancels device metadata updates.
GetDevicesMetadata GetDevicesMetadataRequest .resourceaggregate.pb.DeviceMetadataUpdated stream Gets metadata of the devices. Is contains online/offline or shadown synchronization status.
GetEvents GetEventsRequest GetEventsResponse stream Get events for given combination of device id, resource id and timestamp

Top

grpc-gateway/pb/updateDeviceMetadata.proto

UpdateDeviceMetadataRequest
Field Type Label Description
device_id string
twin_enabled bool
twin_force_synchronization bool force synchronization IoT hub with the device resources and set twin_enabled to true. Use to address potential synchronization issues and prevent operational discrepancies.
time_to_live int64 command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).

UpdateDeviceMetadataResponse
Field Type Label Description
data resourceaggregate.pb.DeviceMetadataUpdated

Top

resource-aggregate/pb/resources.proto

AuditContext
Field Type Label Description
user_id string
correlation_id string
owner string

Content
Field Type Label Description
data bytes
content_type string
coap_content_format int32 -1 means content-format was not provided

EndpointInformation
Field Type Label Description
endpoint string
priority int64

Policy
Field Type Label Description
bit_flags int32

Resource

https://github.com/openconnectivityfoundation/core/blob/master/schemas/oic.links.properties.core-schema.json

Field Type Label Description
href string
device_id string
resource_types string repeated
interfaces string repeated
anchor string
title string
supported_content_types string repeated
valid_until int64
policy Policy
endpoint_informations EndpointInformation repeated

ResourceId
Field Type Label Description
device_id string
href string

Status
Name Number Description
UNKNOWN 0
OK 1
BAD_REQUEST 2
UNAUTHORIZED 3
FORBIDDEN 4
NOT_FOUND 5
UNAVAILABLE 6
NOT_IMPLEMENTED 7
ACCEPTED 8
ERROR 9
METHOD_NOT_ALLOWED 10
CREATED 11
CANCELED 12 Canceled indicates the operation was canceled (typically by the user).
NOT_MODIFIED 13 Valid indicates the content hasn't changed. (provided etag in GET request is same as the resource etag).

Top

resource-aggregate/pb/events.proto

DeviceMetadataSnapshotTaken
Field Type Label Description
device_id string
device_metadata_updated DeviceMetadataUpdated
update_pendings DeviceMetadataUpdatePending repeated expired events will be removed by creating a new snapshot.
event_metadata EventMetadata

DeviceMetadataUpdatePending
Field Type Label Description
device_id string
twin_enabled bool
twin_force_synchronization bool
audit_context AuditContext
event_metadata EventMetadata
valid_until int64 unix timestamp in nanoseconds (https://golang.org/pkg/time/#Time.UnixNano) when pending event is considered as expired. 0 means forever.
open_telemetry_carrier DeviceMetadataUpdatePending.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

DeviceMetadataUpdatePending.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

DeviceMetadataUpdated
Field Type Label Description
device_id string
connection Connection
twin_synchronization TwinSynchronization
twin_enabled bool
audit_context AuditContext
event_metadata EventMetadata
canceled bool it true then the command with audit_context.correlation_id was canceled.
open_telemetry_carrier DeviceMetadataUpdated.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

DeviceMetadataUpdated.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

EventMetadata
Field Type Label Description
version uint64
timestamp int64
connection_id string
sequence uint64 sequence number within the same connection_id; the ResourceChanged event uses the value to skip old events, other event types might not fill the value
hub_id string the hub which sent the event

ResourceChanged
Field Type Label Description
resource_id ResourceId
content Content
status Status
audit_context AuditContext
event_metadata EventMetadata
etag bytes etag of the resource used by twin synchronization
open_telemetry_carrier ResourceChanged.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceChanged.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceCreatePending
Field Type Label Description
resource_id ResourceId
content Content
audit_context AuditContext
event_metadata EventMetadata
valid_until int64 unix timestamp in nanoseconds (https://golang.org/pkg/time/#Time.UnixNano) when pending event is considered as expired. 0 means forever.
open_telemetry_carrier ResourceCreatePending.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceCreatePending.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceCreated
Field Type Label Description
resource_id ResourceId
status Status
content Content
audit_context AuditContext
event_metadata EventMetadata
open_telemetry_carrier ResourceCreated.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceCreated.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceDeletePending
Field Type Label Description
resource_id ResourceId
audit_context AuditContext
event_metadata EventMetadata
valid_until int64 unix timestamp in nanoseconds (https://golang.org/pkg/time/#Time.UnixNano) when pending event is considered as expired. 0 means forever.
resource_interface string
open_telemetry_carrier ResourceDeletePending.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceDeletePending.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceDeleted
Field Type Label Description
resource_id ResourceId
status Status
content Content
audit_context AuditContext
event_metadata EventMetadata
open_telemetry_carrier ResourceDeleted.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceDeleted.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceLinksPublished

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.wk.rd.swagger.json#L173

Field Type Label Description
device_id string
resources Resource repeated
audit_context AuditContext
event_metadata EventMetadata
open_telemetry_carrier ResourceLinksPublished.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceLinksPublished.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceLinksSnapshotTaken
Field Type Label Description
device_id string
resources ResourceLinksSnapshotTaken.ResourcesEntry repeated
event_metadata EventMetadata
audit_context AuditContext

ResourceLinksSnapshotTaken.ResourcesEntry
Field Type Label Description
key string
value Resource

ResourceLinksUnpublished

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.wk.rd.swagger.json #Specification CR needed

Field Type Label Description
device_id string
hrefs string repeated
audit_context AuditContext
event_metadata EventMetadata
open_telemetry_carrier ResourceLinksUnpublished.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceLinksUnpublished.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceRetrievePending
Field Type Label Description
resource_id ResourceId
resource_interface string
audit_context AuditContext
event_metadata EventMetadata
valid_until int64 unix timestamp in nanoseconds (https://golang.org/pkg/time/#Time.UnixNano) when pending event is considered as expired. 0 means forever.
etag bytes repeated
open_telemetry_carrier ResourceRetrievePending.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceRetrievePending.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceRetrieved
Field Type Label Description
resource_id ResourceId
status Status
content Content
audit_context AuditContext
event_metadata EventMetadata
etag bytes
open_telemetry_carrier ResourceRetrieved.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceRetrieved.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceStateSnapshotTaken
Field Type Label Description
resource_id ResourceId
latest_resource_change ResourceChanged
resource_create_pendings ResourceCreatePending repeated expired events will be removed by creating a new snapshot.
resource_retrieve_pendings ResourceRetrievePending repeated expired events will be removed by creating a new snapshot.
resource_update_pendings ResourceUpdatePending repeated expired events will be removed by creating a new snapshot.
resource_delete_pendings ResourceDeletePending repeated expired events will be removed by creating a new snapshot.
audit_context AuditContext
event_metadata EventMetadata

ResourceUpdatePending
Field Type Label Description
resource_id ResourceId
resource_interface string
content Content
audit_context AuditContext
event_metadata EventMetadata
valid_until int64 unix timestamp in nanoseconds (https://golang.org/pkg/time/#Time.UnixNano) when pending event is considered as expired. 0 means forever.
open_telemetry_carrier ResourceUpdatePending.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceUpdatePending.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ResourceUpdated
Field Type Label Description
resource_id ResourceId
status Status
content Content
audit_context AuditContext
event_metadata EventMetadata
open_telemetry_carrier ResourceUpdated.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ResourceUpdated.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ServiceMetadataSnapshotTaken
Field Type Label Description
service_metadata_updated ServiceMetadataUpdated
event_metadata EventMetadata

ServiceMetadataUpdated
Field Type Label Description
services_heartbeat ServicesHeartbeat
event_metadata EventMetadata
audit_context AuditContext
open_telemetry_carrier ServiceMetadataUpdated.OpenTelemetryCarrierEntry repeated Open telemetry data propagated to asynchronous events

ServiceMetadataUpdated.OpenTelemetryCarrierEntry
Field Type Label Description
key string
value string

ServicesHeartbeat
Field Type Label Description
valid ServicesHeartbeat.Heartbeat repeated services which heartbeat is still valid
expired ServicesHeartbeat.Heartbeat repeated services which heartbeat is already expired

ServicesHeartbeat.Heartbeat
Field Type Label Description
service_id string generated unique id during start the service
valid_until int64 unix timestamp in nanoseconds (https://golang.org/pkg/time/#Time.UnixNano) when service heartbeat is considered as expired.

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)

Documentation

Overview

Package pb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	GrpcGateway_GetDevices_FullMethodName                   = "/grpcgateway.pb.GrpcGateway/GetDevices"
	GrpcGateway_DeleteDevices_FullMethodName                = "/grpcgateway.pb.GrpcGateway/DeleteDevices"
	GrpcGateway_GetResourceLinks_FullMethodName             = "/grpcgateway.pb.GrpcGateway/GetResourceLinks"
	GrpcGateway_GetResourceFromDevice_FullMethodName        = "/grpcgateway.pb.GrpcGateway/GetResourceFromDevice"
	GrpcGateway_GetResources_FullMethodName                 = "/grpcgateway.pb.GrpcGateway/GetResources"
	GrpcGateway_UpdateResource_FullMethodName               = "/grpcgateway.pb.GrpcGateway/UpdateResource"
	GrpcGateway_SubscribeToEvents_FullMethodName            = "/grpcgateway.pb.GrpcGateway/SubscribeToEvents"
	GrpcGateway_GetHubConfiguration_FullMethodName          = "/grpcgateway.pb.GrpcGateway/GetHubConfiguration"
	GrpcGateway_DeleteResource_FullMethodName               = "/grpcgateway.pb.GrpcGateway/DeleteResource"
	GrpcGateway_CreateResource_FullMethodName               = "/grpcgateway.pb.GrpcGateway/CreateResource"
	GrpcGateway_UpdateDeviceMetadata_FullMethodName         = "/grpcgateway.pb.GrpcGateway/UpdateDeviceMetadata"
	GrpcGateway_GetPendingCommands_FullMethodName           = "/grpcgateway.pb.GrpcGateway/GetPendingCommands"
	GrpcGateway_CancelPendingCommands_FullMethodName        = "/grpcgateway.pb.GrpcGateway/CancelPendingCommands"
	GrpcGateway_CancelPendingMetadataUpdates_FullMethodName = "/grpcgateway.pb.GrpcGateway/CancelPendingMetadataUpdates"
	GrpcGateway_GetDevicesMetadata_FullMethodName           = "/grpcgateway.pb.GrpcGateway/GetDevicesMetadata"
	GrpcGateway_GetEvents_FullMethodName                    = "/grpcgateway.pb.GrpcGateway/GetEvents"
)

Variables

View Source
var (
	GetDevicesRequest_Status_name = map[int32]string{
		0: "ONLINE",
		1: "OFFLINE",
	}
	GetDevicesRequest_Status_value = map[string]int32{
		"ONLINE":  0,
		"OFFLINE": 1,
	}
)

Enum value maps for GetDevicesRequest_Status.

View Source
var (
	SubscribeToEvents_CreateSubscription_Event_name = map[int32]string{
		0:  "REGISTERED",
		1:  "UNREGISTERED",
		4:  "DEVICE_METADATA_UPDATED",
		5:  "DEVICE_METADATA_UPDATE_PENDING",
		6:  "RESOURCE_PUBLISHED",
		7:  "RESOURCE_UNPUBLISHED",
		8:  "RESOURCE_UPDATE_PENDING",
		9:  "RESOURCE_UPDATED",
		10: "RESOURCE_RETRIEVE_PENDING",
		11: "RESOURCE_RETRIEVED",
		12: "RESOURCE_DELETE_PENDING",
		13: "RESOURCE_DELETED",
		14: "RESOURCE_CREATE_PENDING",
		15: "RESOURCE_CREATED",
		16: "RESOURCE_CHANGED",
	}
	SubscribeToEvents_CreateSubscription_Event_value = map[string]int32{
		"REGISTERED":                     0,
		"UNREGISTERED":                   1,
		"DEVICE_METADATA_UPDATED":        4,
		"DEVICE_METADATA_UPDATE_PENDING": 5,
		"RESOURCE_PUBLISHED":             6,
		"RESOURCE_UNPUBLISHED":           7,
		"RESOURCE_UPDATE_PENDING":        8,
		"RESOURCE_UPDATED":               9,
		"RESOURCE_RETRIEVE_PENDING":      10,
		"RESOURCE_RETRIEVED":             11,
		"RESOURCE_DELETE_PENDING":        12,
		"RESOURCE_DELETED":               13,
		"RESOURCE_CREATE_PENDING":        14,
		"RESOURCE_CREATED":               15,
		"RESOURCE_CHANGED":               16,
	}
)

Enum value maps for SubscribeToEvents_CreateSubscription_Event.

View Source
var (
	Event_OperationProcessed_ErrorStatus_Code_name = map[int32]string{
		0: "OK",
		1: "ERROR",
		2: "NOT_FOUND",
	}
	Event_OperationProcessed_ErrorStatus_Code_value = map[string]int32{
		"OK":        0,
		"ERROR":     1,
		"NOT_FOUND": 2,
	}
)

Enum value maps for Event_OperationProcessed_ErrorStatus_Code.

View Source
var (
	Device_OwnershipStatus_name = map[int32]string{
		0: "UNKNOWN",
		1: "UNOWNED",
		2: "OWNED",
		3: "UNSUPPORTED",
	}
	Device_OwnershipStatus_value = map[string]int32{
		"UNKNOWN":     0,
		"UNOWNED":     1,
		"OWNED":       2,
		"UNSUPPORTED": 3,
	}
)

Enum value maps for Device_OwnershipStatus.

View Source
var (
	GetPendingCommandsRequest_Command_name = map[int32]string{
		0: "RESOURCE_CREATE",
		1: "RESOURCE_RETRIEVE",
		2: "RESOURCE_UPDATE",
		3: "RESOURCE_DELETE",
		4: "DEVICE_METADATA_UPDATE",
	}
	GetPendingCommandsRequest_Command_value = map[string]int32{
		"RESOURCE_CREATE":        0,
		"RESOURCE_RETRIEVE":      1,
		"RESOURCE_UPDATE":        2,
		"RESOURCE_DELETE":        3,
		"DEVICE_METADATA_UPDATE": 4,
	}
)

Enum value maps for GetPendingCommandsRequest_Command.

View Source
var File_grpc_gateway_pb_cancelCommands_proto protoreflect.FileDescriptor
View Source
var File_grpc_gateway_pb_devices_proto protoreflect.FileDescriptor
View Source
var File_grpc_gateway_pb_events_proto protoreflect.FileDescriptor
View Source
var File_grpc_gateway_pb_getDevicesMetadata_proto protoreflect.FileDescriptor
View Source
var File_grpc_gateway_pb_getPendingCommands_proto protoreflect.FileDescriptor
View Source
var File_grpc_gateway_pb_hubConfiguration_proto protoreflect.FileDescriptor
View Source
var File_grpc_gateway_pb_updateDeviceMetadata_proto protoreflect.FileDescriptor
View Source
var GrpcGateway_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "grpcgateway.pb.GrpcGateway",
	HandlerType: (*GrpcGatewayServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "DeleteDevices",
			Handler:    _GrpcGateway_DeleteDevices_Handler,
		},
		{
			MethodName: "GetResourceFromDevice",
			Handler:    _GrpcGateway_GetResourceFromDevice_Handler,
		},
		{
			MethodName: "UpdateResource",
			Handler:    _GrpcGateway_UpdateResource_Handler,
		},
		{
			MethodName: "GetHubConfiguration",
			Handler:    _GrpcGateway_GetHubConfiguration_Handler,
		},
		{
			MethodName: "DeleteResource",
			Handler:    _GrpcGateway_DeleteResource_Handler,
		},
		{
			MethodName: "CreateResource",
			Handler:    _GrpcGateway_CreateResource_Handler,
		},
		{
			MethodName: "UpdateDeviceMetadata",
			Handler:    _GrpcGateway_UpdateDeviceMetadata_Handler,
		},
		{
			MethodName: "CancelPendingCommands",
			Handler:    _GrpcGateway_CancelPendingCommands_Handler,
		},
		{
			MethodName: "CancelPendingMetadataUpdates",
			Handler:    _GrpcGateway_CancelPendingMetadataUpdates_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "GetDevices",
			Handler:       _GrpcGateway_GetDevices_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "GetResourceLinks",
			Handler:       _GrpcGateway_GetResourceLinks_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "GetResources",
			Handler:       _GrpcGateway_GetResources_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "SubscribeToEvents",
			Handler:       _GrpcGateway_SubscribeToEvents_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "GetPendingCommands",
			Handler:       _GrpcGateway_GetPendingCommands_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "GetDevicesMetadata",
			Handler:       _GrpcGateway_GetDevicesMetadata_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "GetEvents",
			Handler:       _GrpcGateway_GetEvents_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "grpc-gateway/pb/service.proto",
}

GrpcGateway_ServiceDesc is the grpc.ServiceDesc for GrpcGateway service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterGrpcGatewayHandler

func RegisterGrpcGatewayHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterGrpcGatewayHandler registers the http handlers for service GrpcGateway to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterGrpcGatewayHandlerClient

func RegisterGrpcGatewayHandlerClient(ctx context.Context, mux *runtime.ServeMux, client GrpcGatewayClient) error

RegisterGrpcGatewayHandlerClient registers the http handlers for service GrpcGateway to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "GrpcGatewayClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "GrpcGatewayClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "GrpcGatewayClient" to call the correct interceptors.

func RegisterGrpcGatewayHandlerFromEndpoint

func RegisterGrpcGatewayHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterGrpcGatewayHandlerFromEndpoint is same as RegisterGrpcGatewayHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterGrpcGatewayHandlerServer

func RegisterGrpcGatewayHandlerServer(ctx context.Context, mux *runtime.ServeMux, server GrpcGatewayServer) error

RegisterGrpcGatewayHandlerServer registers the http handlers for service GrpcGateway to "mux". UnaryRPC :call GrpcGatewayServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterGrpcGatewayHandlerFromEndpoint instead.

func RegisterGrpcGatewayServer

func RegisterGrpcGatewayServer(s grpc.ServiceRegistrar, srv GrpcGatewayServer)

Types

type BuildInfo added in v2.8.0

type BuildInfo struct {

	// version of the service
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// build date of the service
	BuildDate string `protobuf:"bytes,2,opt,name=build_date,json=buildDate,proto3" json:"build_date,omitempty"`
	// commit hash of the service
	CommitHash string `protobuf:"bytes,3,opt,name=commit_hash,json=commitHash,proto3" json:"commit_hash,omitempty"`
	// commit date of the service
	CommitDate string `protobuf:"bytes,4,opt,name=commit_date,json=commitDate,proto3" json:"commit_date,omitempty"`
	// release url of the service
	ReleaseUrl string `protobuf:"bytes,5,opt,name=release_url,json=releaseUrl,proto3" json:"release_url,omitempty"`
	// contains filtered or unexported fields
}

func (*BuildInfo) Descriptor deprecated added in v2.8.0

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

Deprecated: Use BuildInfo.ProtoReflect.Descriptor instead.

func (*BuildInfo) GetBuildDate added in v2.8.0

func (x *BuildInfo) GetBuildDate() string

func (*BuildInfo) GetCommitDate added in v2.8.0

func (x *BuildInfo) GetCommitDate() string

func (*BuildInfo) GetCommitHash added in v2.8.0

func (x *BuildInfo) GetCommitHash() string

func (*BuildInfo) GetReleaseUrl added in v2.8.0

func (x *BuildInfo) GetReleaseUrl() string

func (*BuildInfo) GetVersion added in v2.8.0

func (x *BuildInfo) GetVersion() string

func (*BuildInfo) ProtoMessage added in v2.8.0

func (*BuildInfo) ProtoMessage()

func (*BuildInfo) ProtoReflect added in v2.8.0

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

func (*BuildInfo) Reset added in v2.8.0

func (x *BuildInfo) Reset()

func (*BuildInfo) String added in v2.8.0

func (x *BuildInfo) String() string

type CancelPendingCommandsRequest

type CancelPendingCommandsRequest struct {
	ResourceId          *commands.ResourceId `protobuf:"bytes,1,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	CorrelationIdFilter []string             `protobuf:"bytes,2,rep,name=correlation_id_filter,json=correlationIdFilter,proto3" json:"correlation_id_filter,omitempty"` // empty array means all.
	// contains filtered or unexported fields
}

func (*CancelPendingCommandsRequest) Descriptor deprecated

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

Deprecated: Use CancelPendingCommandsRequest.ProtoReflect.Descriptor instead.

func (*CancelPendingCommandsRequest) GetCorrelationIdFilter

func (x *CancelPendingCommandsRequest) GetCorrelationIdFilter() []string

func (*CancelPendingCommandsRequest) GetResourceId

func (x *CancelPendingCommandsRequest) GetResourceId() *commands.ResourceId

func (*CancelPendingCommandsRequest) ProtoMessage

func (*CancelPendingCommandsRequest) ProtoMessage()

func (*CancelPendingCommandsRequest) ProtoReflect

func (*CancelPendingCommandsRequest) Reset

func (x *CancelPendingCommandsRequest) Reset()

func (*CancelPendingCommandsRequest) String

type CancelPendingCommandsResponse

type CancelPendingCommandsResponse struct {
	CorrelationIds []string `protobuf:"bytes,1,rep,name=correlation_ids,json=correlationIds,proto3" json:"correlation_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelPendingCommandsResponse) Descriptor deprecated

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

Deprecated: Use CancelPendingCommandsResponse.ProtoReflect.Descriptor instead.

func (*CancelPendingCommandsResponse) GetCorrelationIds

func (x *CancelPendingCommandsResponse) GetCorrelationIds() []string

func (*CancelPendingCommandsResponse) ProtoMessage

func (*CancelPendingCommandsResponse) ProtoMessage()

func (*CancelPendingCommandsResponse) ProtoReflect

func (*CancelPendingCommandsResponse) Reset

func (x *CancelPendingCommandsResponse) Reset()

func (*CancelPendingCommandsResponse) String

type CancelPendingMetadataUpdatesRequest

type CancelPendingMetadataUpdatesRequest struct {
	DeviceId            string   `protobuf:"bytes,1,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	CorrelationIdFilter []string `protobuf:"bytes,2,rep,name=correlation_id_filter,json=correlationIdFilter,proto3" json:"correlation_id_filter,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelPendingMetadataUpdatesRequest) Descriptor deprecated

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

Deprecated: Use CancelPendingMetadataUpdatesRequest.ProtoReflect.Descriptor instead.

func (*CancelPendingMetadataUpdatesRequest) GetCorrelationIdFilter

func (x *CancelPendingMetadataUpdatesRequest) GetCorrelationIdFilter() []string

func (*CancelPendingMetadataUpdatesRequest) GetDeviceId

func (*CancelPendingMetadataUpdatesRequest) ProtoMessage

func (*CancelPendingMetadataUpdatesRequest) ProtoMessage()

func (*CancelPendingMetadataUpdatesRequest) ProtoReflect

func (*CancelPendingMetadataUpdatesRequest) Reset

func (*CancelPendingMetadataUpdatesRequest) String

type Content

type Content struct {
	ContentType string `protobuf:"bytes,1,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	Data        []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Content) Descriptor deprecated

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

Deprecated: Use Content.ProtoReflect.Descriptor instead.

func (*Content) GetContentType

func (x *Content) GetContentType() string

func (*Content) GetData

func (x *Content) GetData() []byte

func (*Content) ProtoMessage

func (*Content) ProtoMessage()

func (*Content) ProtoReflect

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

func (*Content) Reset

func (x *Content) Reset()

func (*Content) String

func (x *Content) String() string

type CreateResourceRequest

type CreateResourceRequest struct {
	ResourceId *commands.ResourceId `protobuf:"bytes,1,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	Content    *Content             `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	TimeToLive int64                `protobuf:"varint,3,opt,name=time_to_live,json=timeToLive,proto3" json:"time_to_live,omitempty"` // command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).
	// contains filtered or unexported fields
}

func (*CreateResourceRequest) Descriptor deprecated

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

Deprecated: Use CreateResourceRequest.ProtoReflect.Descriptor instead.

func (*CreateResourceRequest) GetContent

func (x *CreateResourceRequest) GetContent() *Content

func (*CreateResourceRequest) GetResourceId

func (x *CreateResourceRequest) GetResourceId() *commands.ResourceId

func (*CreateResourceRequest) GetTimeToLive

func (x *CreateResourceRequest) GetTimeToLive() int64

func (*CreateResourceRequest) ProtoMessage

func (*CreateResourceRequest) ProtoMessage()

func (*CreateResourceRequest) ProtoReflect

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

func (*CreateResourceRequest) Reset

func (x *CreateResourceRequest) Reset()

func (*CreateResourceRequest) String

func (x *CreateResourceRequest) String() string

func (*CreateResourceRequest) ToRACommand

type CreateResourceResponse

type CreateResourceResponse struct {
	Data *events.ResourceCreated `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateResourceResponse) Descriptor deprecated

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

Deprecated: Use CreateResourceResponse.ProtoReflect.Descriptor instead.

func (*CreateResourceResponse) GetData

func (*CreateResourceResponse) ProtoMessage

func (*CreateResourceResponse) ProtoMessage()

func (*CreateResourceResponse) ProtoReflect

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

func (*CreateResourceResponse) Reset

func (x *CreateResourceResponse) Reset()

func (*CreateResourceResponse) String

func (x *CreateResourceResponse) String() string

type DeleteDevicesRequest

type DeleteDevicesRequest struct {
	DeviceIdFilter []string `protobuf:"bytes,1,rep,name=device_id_filter,json=deviceIdFilter,proto3" json:"device_id_filter,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteDevicesRequest) Descriptor deprecated

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

Deprecated: Use DeleteDevicesRequest.ProtoReflect.Descriptor instead.

func (*DeleteDevicesRequest) GetDeviceIdFilter

func (x *DeleteDevicesRequest) GetDeviceIdFilter() []string

func (*DeleteDevicesRequest) ProtoMessage

func (*DeleteDevicesRequest) ProtoMessage()

func (*DeleteDevicesRequest) ProtoReflect

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

func (*DeleteDevicesRequest) Reset

func (x *DeleteDevicesRequest) Reset()

func (*DeleteDevicesRequest) String

func (x *DeleteDevicesRequest) String() string

type DeleteDevicesResponse

type DeleteDevicesResponse struct {
	DeviceIds []string `protobuf:"bytes,1,rep,name=device_ids,json=deviceIds,proto3" json:"device_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteDevicesResponse) Descriptor deprecated

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

Deprecated: Use DeleteDevicesResponse.ProtoReflect.Descriptor instead.

func (*DeleteDevicesResponse) GetDeviceIds

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

func (*DeleteDevicesResponse) ProtoMessage

func (*DeleteDevicesResponse) ProtoMessage()

func (*DeleteDevicesResponse) ProtoReflect

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

func (*DeleteDevicesResponse) Reset

func (x *DeleteDevicesResponse) Reset()

func (*DeleteDevicesResponse) String

func (x *DeleteDevicesResponse) String() string

type DeleteResourceRequest

type DeleteResourceRequest struct {
	ResourceId        *commands.ResourceId `protobuf:"bytes,1,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	TimeToLive        int64                `protobuf:"varint,2,opt,name=time_to_live,json=timeToLive,proto3" json:"time_to_live,omitempty"` // command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).
	ResourceInterface string               `protobuf:"bytes,3,opt,name=resource_interface,json=resourceInterface,proto3" json:"resource_interface,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteResourceRequest) Descriptor deprecated

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

Deprecated: Use DeleteResourceRequest.ProtoReflect.Descriptor instead.

func (*DeleteResourceRequest) GetResourceId

func (x *DeleteResourceRequest) GetResourceId() *commands.ResourceId

func (*DeleteResourceRequest) GetResourceInterface added in v2.13.1

func (x *DeleteResourceRequest) GetResourceInterface() string

func (*DeleteResourceRequest) GetTimeToLive

func (x *DeleteResourceRequest) GetTimeToLive() int64

func (*DeleteResourceRequest) ProtoMessage

func (*DeleteResourceRequest) ProtoMessage()

func (*DeleteResourceRequest) ProtoReflect

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

func (*DeleteResourceRequest) Reset

func (x *DeleteResourceRequest) Reset()

func (*DeleteResourceRequest) String

func (x *DeleteResourceRequest) String() string

func (*DeleteResourceRequest) ToRACommand

type DeleteResourceResponse

type DeleteResourceResponse struct {
	Data *events.ResourceDeleted `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteResourceResponse) Descriptor deprecated

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

Deprecated: Use DeleteResourceResponse.ProtoReflect.Descriptor instead.

func (*DeleteResourceResponse) GetData

func (*DeleteResourceResponse) ProtoMessage

func (*DeleteResourceResponse) ProtoMessage()

func (*DeleteResourceResponse) ProtoReflect

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

func (*DeleteResourceResponse) Reset

func (x *DeleteResourceResponse) Reset()

func (*DeleteResourceResponse) String

func (x *DeleteResourceResponse) String() string

type Device

type Device struct {
	Id                    string                  `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Types                 []string                `protobuf:"bytes,2,rep,name=types,proto3" json:"types,omitempty"`
	Name                  string                  `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	Metadata              *Device_Metadata        `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	ManufacturerName      []*LocalizedString      `protobuf:"bytes,5,rep,name=manufacturer_name,json=manufacturerName,proto3" json:"manufacturer_name,omitempty"`
	ModelNumber           string                  `protobuf:"bytes,6,opt,name=model_number,json=modelNumber,proto3" json:"model_number,omitempty"`
	Interfaces            []string                `protobuf:"bytes,7,rep,name=interfaces,proto3" json:"interfaces,omitempty"`
	ProtocolIndependentId string                  `` /* 126-byte string literal not displayed */
	Data                  *events.ResourceChanged `protobuf:"bytes,9,opt,name=data,proto3" json:"data,omitempty"`
	// ownership status of the device
	OwnershipStatus Device_OwnershipStatus `` /* 151-byte string literal not displayed */
	// endpoints with schemas which are hosted by the device
	Endpoints []string `protobuf:"bytes,11,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
	// contains filtered or unexported fields
}

func SchemaDeviceToProto

func SchemaDeviceToProto(d *device.Device) *Device

func (*Device) Descriptor deprecated

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

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetData added in v2.4.4

func (x *Device) GetData() *events.ResourceChanged

func (*Device) GetEndpoints added in v2.4.4

func (x *Device) GetEndpoints() []string

func (*Device) GetId

func (x *Device) GetId() string

func (*Device) GetInterfaces

func (x *Device) GetInterfaces() []string

func (*Device) GetManufacturerName

func (x *Device) GetManufacturerName() []*LocalizedString

func (*Device) GetMetadata

func (x *Device) GetMetadata() *Device_Metadata

func (*Device) GetModelNumber

func (x *Device) GetModelNumber() string

func (*Device) GetName

func (x *Device) GetName() string

func (*Device) GetOwnershipStatus added in v2.4.4

func (x *Device) GetOwnershipStatus() Device_OwnershipStatus

func (*Device) GetProtocolIndependentId

func (x *Device) GetProtocolIndependentId() string

func (*Device) GetTypes

func (x *Device) GetTypes() []string

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

func (*Device) ToSchema

func (d *Device) ToSchema() device.Device

type DeviceOAuthClient added in v2.5.0

type DeviceOAuthClient struct {
	ClientId     string   `protobuf:"bytes,1,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty" yaml:"clientID"` // @gotags: yaml:"clientID"
	Audience     string   `protobuf:"bytes,2,opt,name=audience,proto3" json:"audience,omitempty"`
	Scopes       []string `protobuf:"bytes,3,rep,name=scopes,proto3" json:"scopes,omitempty"`
	ProviderName string   `protobuf:"bytes,4,opt,name=provider_name,json=providerName,proto3" json:"provider_name,omitempty" yaml:"providerName"` // @gotags: yaml:"providerName"
	// contains filtered or unexported fields
}

func (*DeviceOAuthClient) Clone added in v2.7.4

func (*DeviceOAuthClient) Descriptor deprecated added in v2.5.0

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

Deprecated: Use DeviceOAuthClient.ProtoReflect.Descriptor instead.

func (*DeviceOAuthClient) GetAudience added in v2.5.0

func (x *DeviceOAuthClient) GetAudience() string

func (*DeviceOAuthClient) GetClientId added in v2.5.0

func (x *DeviceOAuthClient) GetClientId() string

func (*DeviceOAuthClient) GetProviderName added in v2.5.0

func (x *DeviceOAuthClient) GetProviderName() string

func (*DeviceOAuthClient) GetScopes added in v2.5.0

func (x *DeviceOAuthClient) GetScopes() []string

func (*DeviceOAuthClient) ProtoMessage added in v2.5.0

func (*DeviceOAuthClient) ProtoMessage()

func (*DeviceOAuthClient) ProtoReflect added in v2.5.0

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

func (*DeviceOAuthClient) Reset added in v2.5.0

func (x *DeviceOAuthClient) Reset()

func (*DeviceOAuthClient) String added in v2.5.0

func (x *DeviceOAuthClient) String() string

type Device_Metadata

type Device_Metadata struct {
	Connection          *commands.Connection          `protobuf:"bytes,1,opt,name=connection,proto3" json:"connection,omitempty"`
	TwinSynchronization *commands.TwinSynchronization `protobuf:"bytes,3,opt,name=twin_synchronization,json=twinSynchronization,proto3" json:"twin_synchronization,omitempty"`
	TwinEnabled         bool                          `protobuf:"varint,4,opt,name=twin_enabled,json=twinEnabled,proto3" json:"twin_enabled,omitempty"`
	// contains filtered or unexported fields
}

func (*Device_Metadata) Descriptor deprecated

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

Deprecated: Use Device_Metadata.ProtoReflect.Descriptor instead.

func (*Device_Metadata) GetConnection added in v2.6.0

func (x *Device_Metadata) GetConnection() *commands.Connection

func (*Device_Metadata) GetTwinEnabled added in v2.6.0

func (x *Device_Metadata) GetTwinEnabled() bool

func (*Device_Metadata) GetTwinSynchronization added in v2.6.0

func (x *Device_Metadata) GetTwinSynchronization() *commands.TwinSynchronization

func (*Device_Metadata) ProtoMessage

func (*Device_Metadata) ProtoMessage()

func (*Device_Metadata) ProtoReflect

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

func (*Device_Metadata) Reset

func (x *Device_Metadata) Reset()

func (*Device_Metadata) String

func (x *Device_Metadata) String() string

type Device_OwnershipStatus added in v2.4.4

type Device_OwnershipStatus int32
const (
	// cannot determine ownership status
	Device_UNKNOWN Device_OwnershipStatus = 0
	// device is ready to be owned the user
	Device_UNOWNED Device_OwnershipStatus = 1
	// device is owned by the user. to determine who own the device you need to get ownership resource /oic/sec/doxm
	Device_OWNED Device_OwnershipStatus = 2
	// set when device is not secured. (iotivity-lite was built without security)
	Device_UNSUPPORTED Device_OwnershipStatus = 3
)

func (Device_OwnershipStatus) Descriptor added in v2.4.4

func (Device_OwnershipStatus) Enum added in v2.4.4

func (Device_OwnershipStatus) EnumDescriptor deprecated added in v2.4.4

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

Deprecated: Use Device_OwnershipStatus.Descriptor instead.

func (Device_OwnershipStatus) Number added in v2.4.4

func (Device_OwnershipStatus) String added in v2.4.4

func (x Device_OwnershipStatus) String() string

func (Device_OwnershipStatus) Type added in v2.4.4

type Event

type Event struct {
	SubscriptionId string `protobuf:"bytes,1,opt,name=subscription_id,json=subscriptionId,proto3" json:"subscription_id,omitempty"` // subscription id provided by grpc
	CorrelationId  string `protobuf:"bytes,2,opt,name=correlation_id,json=correlationId,proto3" json:"correlation_id,omitempty"`
	// Types that are assignable to Type:
	//
	//	*Event_DeviceRegistered_
	//	*Event_DeviceUnregistered_
	//	*Event_ResourcePublished
	//	*Event_ResourceUnpublished
	//	*Event_ResourceChanged
	//	*Event_OperationProcessed_
	//	*Event_SubscriptionCanceled_
	//	*Event_ResourceUpdatePending
	//	*Event_ResourceUpdated
	//	*Event_ResourceRetrievePending
	//	*Event_ResourceRetrieved
	//	*Event_ResourceDeletePending
	//	*Event_ResourceDeleted
	//	*Event_ResourceCreatePending
	//	*Event_ResourceCreated
	//	*Event_DeviceMetadataUpdatePending
	//	*Event_DeviceMetadataUpdated
	Type isEvent_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*Event) Descriptor deprecated

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

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetCorrelationId

func (x *Event) GetCorrelationId() string

func (*Event) GetDeviceMetadataUpdatePending

func (x *Event) GetDeviceMetadataUpdatePending() *events.DeviceMetadataUpdatePending

func (*Event) GetDeviceMetadataUpdated

func (x *Event) GetDeviceMetadataUpdated() *events.DeviceMetadataUpdated

func (*Event) GetDeviceRegistered

func (x *Event) GetDeviceRegistered() *Event_DeviceRegistered

func (*Event) GetDeviceUnregistered

func (x *Event) GetDeviceUnregistered() *Event_DeviceUnregistered

func (*Event) GetOperationProcessed

func (x *Event) GetOperationProcessed() *Event_OperationProcessed

func (*Event) GetResourceChanged

func (x *Event) GetResourceChanged() *events.ResourceChanged

func (*Event) GetResourceCreatePending

func (x *Event) GetResourceCreatePending() *events.ResourceCreatePending

func (*Event) GetResourceCreated

func (x *Event) GetResourceCreated() *events.ResourceCreated

func (*Event) GetResourceDeletePending

func (x *Event) GetResourceDeletePending() *events.ResourceDeletePending

func (*Event) GetResourceDeleted

func (x *Event) GetResourceDeleted() *events.ResourceDeleted

func (*Event) GetResourcePublished

func (x *Event) GetResourcePublished() *events.ResourceLinksPublished

func (*Event) GetResourceRetrievePending

func (x *Event) GetResourceRetrievePending() *events.ResourceRetrievePending

func (*Event) GetResourceRetrieved

func (x *Event) GetResourceRetrieved() *events.ResourceRetrieved

func (*Event) GetResourceUnpublished

func (x *Event) GetResourceUnpublished() *events.ResourceLinksUnpublished

func (*Event) GetResourceUpdatePending

func (x *Event) GetResourceUpdatePending() *events.ResourceUpdatePending

func (*Event) GetResourceUpdated

func (x *Event) GetResourceUpdated() *events.ResourceUpdated

func (*Event) GetSubscriptionCanceled

func (x *Event) GetSubscriptionCanceled() *Event_SubscriptionCanceled

func (*Event) GetSubscriptionId

func (x *Event) GetSubscriptionId() string

func (*Event) GetType

func (m *Event) GetType() isEvent_Type

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

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

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type Event_DeviceMetadataUpdatePending

type Event_DeviceMetadataUpdatePending struct {
	DeviceMetadataUpdatePending *events.DeviceMetadataUpdatePending `protobuf:"bytes,20,opt,name=device_metadata_update_pending,json=deviceMetadataUpdatePending,proto3,oneof"`
}

type Event_DeviceMetadataUpdated

type Event_DeviceMetadataUpdated struct {
	DeviceMetadataUpdated *events.DeviceMetadataUpdated `protobuf:"bytes,21,opt,name=device_metadata_updated,json=deviceMetadataUpdated,proto3,oneof"`
}

type Event_DeviceRegistered

type Event_DeviceRegistered struct {
	DeviceIds     []string               `protobuf:"bytes,1,rep,name=device_ids,json=deviceIds,proto3" json:"device_ids,omitempty"`
	EventMetadata *events1.EventMetadata `protobuf:"bytes,2,opt,name=event_metadata,json=eventMetadata,proto3" json:"event_metadata,omitempty"` // provides metadata of event
	// Open telemetry data propagated to asynchronous events
	OpenTelemetryCarrier map[string]string `` /* 213-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Event_DeviceRegistered) Descriptor deprecated

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

Deprecated: Use Event_DeviceRegistered.ProtoReflect.Descriptor instead.

func (*Event_DeviceRegistered) GetDeviceIds

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

func (*Event_DeviceRegistered) GetEventMetadata added in v2.9.0

func (x *Event_DeviceRegistered) GetEventMetadata() *events1.EventMetadata

func (*Event_DeviceRegistered) GetOpenTelemetryCarrier added in v2.4.0

func (x *Event_DeviceRegistered) GetOpenTelemetryCarrier() map[string]string

func (*Event_DeviceRegistered) ProtoMessage

func (*Event_DeviceRegistered) ProtoMessage()

func (*Event_DeviceRegistered) ProtoReflect

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

func (*Event_DeviceRegistered) Reset

func (x *Event_DeviceRegistered) Reset()

func (*Event_DeviceRegistered) String

func (x *Event_DeviceRegistered) String() string

type Event_DeviceRegistered_

type Event_DeviceRegistered_ struct {
	DeviceRegistered *Event_DeviceRegistered `protobuf:"bytes,3,opt,name=device_registered,json=deviceRegistered,proto3,oneof"`
}

type Event_DeviceUnregistered

type Event_DeviceUnregistered struct {
	DeviceIds     []string               `protobuf:"bytes,1,rep,name=device_ids,json=deviceIds,proto3" json:"device_ids,omitempty"`
	EventMetadata *events1.EventMetadata `protobuf:"bytes,2,opt,name=event_metadata,json=eventMetadata,proto3" json:"event_metadata,omitempty"` // provides metadata of event
	// Open telemetry data propagated to asynchronous events
	OpenTelemetryCarrier map[string]string `` /* 213-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Event_DeviceUnregistered) Descriptor deprecated

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

Deprecated: Use Event_DeviceUnregistered.ProtoReflect.Descriptor instead.

func (*Event_DeviceUnregistered) GetDeviceIds

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

func (*Event_DeviceUnregistered) GetEventMetadata added in v2.9.0

func (x *Event_DeviceUnregistered) GetEventMetadata() *events1.EventMetadata

func (*Event_DeviceUnregistered) GetOpenTelemetryCarrier added in v2.4.0

func (x *Event_DeviceUnregistered) GetOpenTelemetryCarrier() map[string]string

func (*Event_DeviceUnregistered) ProtoMessage

func (*Event_DeviceUnregistered) ProtoMessage()

func (*Event_DeviceUnregistered) ProtoReflect

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

func (*Event_DeviceUnregistered) Reset

func (x *Event_DeviceUnregistered) Reset()

func (*Event_DeviceUnregistered) String

func (x *Event_DeviceUnregistered) String() string

type Event_DeviceUnregistered_

type Event_DeviceUnregistered_ struct {
	DeviceUnregistered *Event_DeviceUnregistered `protobuf:"bytes,4,opt,name=device_unregistered,json=deviceUnregistered,proto3,oneof"`
}

type Event_OperationProcessed

type Event_OperationProcessed struct {
	ErrorStatus *Event_OperationProcessed_ErrorStatus `protobuf:"bytes,2,opt,name=error_status,json=errorStatus,proto3" json:"error_status,omitempty"`
	// contains filtered or unexported fields
}

func (*Event_OperationProcessed) Descriptor deprecated

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

Deprecated: Use Event_OperationProcessed.ProtoReflect.Descriptor instead.

func (*Event_OperationProcessed) GetErrorStatus

func (*Event_OperationProcessed) ProtoMessage

func (*Event_OperationProcessed) ProtoMessage()

func (*Event_OperationProcessed) ProtoReflect

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

func (*Event_OperationProcessed) Reset

func (x *Event_OperationProcessed) Reset()

func (*Event_OperationProcessed) String

func (x *Event_OperationProcessed) String() string

type Event_OperationProcessed_

type Event_OperationProcessed_ struct {
	OperationProcessed *Event_OperationProcessed `protobuf:"bytes,10,opt,name=operation_processed,json=operationProcessed,proto3,oneof"`
}

type Event_OperationProcessed_ErrorStatus

type Event_OperationProcessed_ErrorStatus struct {
	Code    Event_OperationProcessed_ErrorStatus_Code `protobuf:"varint,1,opt,name=code,proto3,enum=grpcgateway.pb.Event_OperationProcessed_ErrorStatus_Code" json:"code,omitempty"`
	Message string                                    `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*Event_OperationProcessed_ErrorStatus) Descriptor deprecated

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

Deprecated: Use Event_OperationProcessed_ErrorStatus.ProtoReflect.Descriptor instead.

func (*Event_OperationProcessed_ErrorStatus) GetCode

func (*Event_OperationProcessed_ErrorStatus) GetMessage

func (*Event_OperationProcessed_ErrorStatus) ProtoMessage

func (*Event_OperationProcessed_ErrorStatus) ProtoMessage()

func (*Event_OperationProcessed_ErrorStatus) ProtoReflect

func (*Event_OperationProcessed_ErrorStatus) Reset

func (*Event_OperationProcessed_ErrorStatus) String

type Event_OperationProcessed_ErrorStatus_Code

type Event_OperationProcessed_ErrorStatus_Code int32
const (
	Event_OperationProcessed_ErrorStatus_OK        Event_OperationProcessed_ErrorStatus_Code = 0
	Event_OperationProcessed_ErrorStatus_ERROR     Event_OperationProcessed_ErrorStatus_Code = 1
	Event_OperationProcessed_ErrorStatus_NOT_FOUND Event_OperationProcessed_ErrorStatus_Code = 2
)

func (Event_OperationProcessed_ErrorStatus_Code) Descriptor

func (Event_OperationProcessed_ErrorStatus_Code) Enum

func (Event_OperationProcessed_ErrorStatus_Code) EnumDescriptor deprecated

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

Deprecated: Use Event_OperationProcessed_ErrorStatus_Code.Descriptor instead.

func (Event_OperationProcessed_ErrorStatus_Code) Number

func (Event_OperationProcessed_ErrorStatus_Code) String

func (Event_OperationProcessed_ErrorStatus_Code) Type

type Event_ResourceChanged

type Event_ResourceChanged struct {
	ResourceChanged *events.ResourceChanged `protobuf:"bytes,9,opt,name=resource_changed,json=resourceChanged,proto3,oneof"`
}

func (*Event_ResourceChanged) GetResourceId added in v2.8.0

func (e *Event_ResourceChanged) GetResourceId() *commands.ResourceId

type Event_ResourceCreatePending

type Event_ResourceCreatePending struct {
	ResourceCreatePending *events.ResourceCreatePending `protobuf:"bytes,18,opt,name=resource_create_pending,json=resourceCreatePending,proto3,oneof"`
}

func (*Event_ResourceCreatePending) GetResourceId added in v2.8.0

func (e *Event_ResourceCreatePending) GetResourceId() *commands.ResourceId

type Event_ResourceCreated

type Event_ResourceCreated struct {
	ResourceCreated *events.ResourceCreated `protobuf:"bytes,19,opt,name=resource_created,json=resourceCreated,proto3,oneof"`
}

func (*Event_ResourceCreated) GetResourceId added in v2.8.0

func (e *Event_ResourceCreated) GetResourceId() *commands.ResourceId

type Event_ResourceDeletePending

type Event_ResourceDeletePending struct {
	ResourceDeletePending *events.ResourceDeletePending `protobuf:"bytes,16,opt,name=resource_delete_pending,json=resourceDeletePending,proto3,oneof"`
}

func (*Event_ResourceDeletePending) GetResourceId added in v2.8.0

func (e *Event_ResourceDeletePending) GetResourceId() *commands.ResourceId

type Event_ResourceDeleted

type Event_ResourceDeleted struct {
	ResourceDeleted *events.ResourceDeleted `protobuf:"bytes,17,opt,name=resource_deleted,json=resourceDeleted,proto3,oneof"`
}

func (*Event_ResourceDeleted) GetResourceId added in v2.8.0

func (e *Event_ResourceDeleted) GetResourceId() *commands.ResourceId

type Event_ResourcePublished

type Event_ResourcePublished struct {
	ResourcePublished *events.ResourceLinksPublished `protobuf:"bytes,7,opt,name=resource_published,json=resourcePublished,proto3,oneof"`
}

type Event_ResourceRetrievePending

type Event_ResourceRetrievePending struct {
	ResourceRetrievePending *events.ResourceRetrievePending `protobuf:"bytes,14,opt,name=resource_retrieve_pending,json=resourceRetrievePending,proto3,oneof"`
}

func (*Event_ResourceRetrievePending) GetResourceId added in v2.8.0

type Event_ResourceRetrieved

type Event_ResourceRetrieved struct {
	ResourceRetrieved *events.ResourceRetrieved `protobuf:"bytes,15,opt,name=resource_retrieved,json=resourceRetrieved,proto3,oneof"`
}

func (*Event_ResourceRetrieved) GetResourceId added in v2.8.0

func (e *Event_ResourceRetrieved) GetResourceId() *commands.ResourceId

type Event_ResourceUnpublished

type Event_ResourceUnpublished struct {
	ResourceUnpublished *events.ResourceLinksUnpublished `protobuf:"bytes,8,opt,name=resource_unpublished,json=resourceUnpublished,proto3,oneof"`
}

type Event_ResourceUpdatePending

type Event_ResourceUpdatePending struct {
	ResourceUpdatePending *events.ResourceUpdatePending `protobuf:"bytes,12,opt,name=resource_update_pending,json=resourceUpdatePending,proto3,oneof"`
}

func (*Event_ResourceUpdatePending) GetResourceId added in v2.8.0

func (e *Event_ResourceUpdatePending) GetResourceId() *commands.ResourceId

type Event_ResourceUpdated

type Event_ResourceUpdated struct {
	ResourceUpdated *events.ResourceUpdated `protobuf:"bytes,13,opt,name=resource_updated,json=resourceUpdated,proto3,oneof"`
}

func (*Event_ResourceUpdated) GetResourceId added in v2.8.0

func (e *Event_ResourceUpdated) GetResourceId() *commands.ResourceId

type Event_SubscriptionCanceled

type Event_SubscriptionCanceled struct {
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

func (*Event_SubscriptionCanceled) Descriptor deprecated

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

Deprecated: Use Event_SubscriptionCanceled.ProtoReflect.Descriptor instead.

func (*Event_SubscriptionCanceled) GetReason

func (x *Event_SubscriptionCanceled) GetReason() string

func (*Event_SubscriptionCanceled) ProtoMessage

func (*Event_SubscriptionCanceled) ProtoMessage()

func (*Event_SubscriptionCanceled) ProtoReflect

func (*Event_SubscriptionCanceled) Reset

func (x *Event_SubscriptionCanceled) Reset()

func (*Event_SubscriptionCanceled) String

func (x *Event_SubscriptionCanceled) String() string

type Event_SubscriptionCanceled_

type Event_SubscriptionCanceled_ struct {
	SubscriptionCanceled *Event_SubscriptionCanceled `protobuf:"bytes,11,opt,name=subscription_canceled,json=subscriptionCanceled,proto3,oneof"`
}

type GetDevicesMetadataRequest

type GetDevicesMetadataRequest struct {
	DeviceIdFilter []string `protobuf:"bytes,1,rep,name=device_id_filter,json=deviceIdFilter,proto3" json:"device_id_filter,omitempty"`
	TypeFilter     []string `protobuf:"bytes,2,rep,name=type_filter,json=typeFilter,proto3" json:"type_filter,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDevicesMetadataRequest) Descriptor deprecated

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

Deprecated: Use GetDevicesMetadataRequest.ProtoReflect.Descriptor instead.

func (*GetDevicesMetadataRequest) GetDeviceIdFilter

func (x *GetDevicesMetadataRequest) GetDeviceIdFilter() []string

func (*GetDevicesMetadataRequest) GetTypeFilter

func (x *GetDevicesMetadataRequest) GetTypeFilter() []string

func (*GetDevicesMetadataRequest) ProtoMessage

func (*GetDevicesMetadataRequest) ProtoMessage()

func (*GetDevicesMetadataRequest) ProtoReflect

func (*GetDevicesMetadataRequest) Reset

func (x *GetDevicesMetadataRequest) Reset()

func (*GetDevicesMetadataRequest) String

func (x *GetDevicesMetadataRequest) String() string

type GetDevicesRequest

type GetDevicesRequest struct {
	TypeFilter     []string                   `protobuf:"bytes,1,rep,name=type_filter,json=typeFilter,proto3" json:"type_filter,omitempty"`
	StatusFilter   []GetDevicesRequest_Status `` /* 150-byte string literal not displayed */
	DeviceIdFilter []string                   `protobuf:"bytes,3,rep,name=device_id_filter,json=deviceIdFilter,proto3" json:"device_id_filter,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDevicesRequest) Descriptor deprecated

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

Deprecated: Use GetDevicesRequest.ProtoReflect.Descriptor instead.

func (*GetDevicesRequest) GetDeviceIdFilter

func (x *GetDevicesRequest) GetDeviceIdFilter() []string

func (*GetDevicesRequest) GetStatusFilter

func (x *GetDevicesRequest) GetStatusFilter() []GetDevicesRequest_Status

func (*GetDevicesRequest) GetTypeFilter

func (x *GetDevicesRequest) GetTypeFilter() []string

func (*GetDevicesRequest) ProtoMessage

func (*GetDevicesRequest) ProtoMessage()

func (*GetDevicesRequest) ProtoReflect

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

func (*GetDevicesRequest) Reset

func (x *GetDevicesRequest) Reset()

func (*GetDevicesRequest) String

func (x *GetDevicesRequest) String() string

type GetDevicesRequest_Status

type GetDevicesRequest_Status int32
const (
	GetDevicesRequest_ONLINE  GetDevicesRequest_Status = 0
	GetDevicesRequest_OFFLINE GetDevicesRequest_Status = 1
)

func (GetDevicesRequest_Status) Descriptor

func (GetDevicesRequest_Status) Enum

func (GetDevicesRequest_Status) EnumDescriptor deprecated

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

Deprecated: Use GetDevicesRequest_Status.Descriptor instead.

func (GetDevicesRequest_Status) Number

func (GetDevicesRequest_Status) String

func (x GetDevicesRequest_Status) String() string

func (GetDevicesRequest_Status) Type

type GetEventsRequest

type GetEventsRequest struct {
	DeviceIdFilter []string `protobuf:"bytes,1,rep,name=device_id_filter,json=deviceIdFilter,proto3" json:"device_id_filter,omitempty"`
	// format {deviceID}{href}. eg "ae424c58-e517-4494-6de7-583536c48213/oic/d"
	//
	// Deprecated: Marked as deprecated in grpc-gateway/pb/events.proto.
	HttpResourceIdFilter []string `protobuf:"bytes,2,rep,name=http_resource_id_filter,json=httpResourceIdFilter,proto3" json:"http_resource_id_filter,omitempty"`
	// filter events with timestamp > than given value
	TimestampFilter  int64               `protobuf:"varint,3,opt,name=timestamp_filter,json=timestampFilter,proto3" json:"timestamp_filter,omitempty"`
	ResourceIdFilter []*ResourceIdFilter `protobuf:"bytes,4,rep,name=resource_id_filter,json=resourceIdFilter,proto3" json:"resource_id_filter,omitempty"` // New resource ID filter. For HTTP requests, use it multiple times as a query parameter like "resourceIdFilter={deviceID}{href}".
	// contains filtered or unexported fields
}

func (*GetEventsRequest) ConvertHTTPResourceIDFilter added in v2.13.0

func (r *GetEventsRequest) ConvertHTTPResourceIDFilter() []*ResourceIdFilter

func (*GetEventsRequest) Descriptor deprecated

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

Deprecated: Use GetEventsRequest.ProtoReflect.Descriptor instead.

func (*GetEventsRequest) GetDeviceIdFilter

func (x *GetEventsRequest) GetDeviceIdFilter() []string

func (*GetEventsRequest) GetHttpResourceIdFilter deprecated added in v2.13.0

func (x *GetEventsRequest) GetHttpResourceIdFilter() []string

Deprecated: Marked as deprecated in grpc-gateway/pb/events.proto.

func (*GetEventsRequest) GetResourceIdFilter

func (x *GetEventsRequest) GetResourceIdFilter() []*ResourceIdFilter

func (*GetEventsRequest) GetTimestampFilter

func (x *GetEventsRequest) GetTimestampFilter() int64

func (*GetEventsRequest) ProtoMessage

func (*GetEventsRequest) ProtoMessage()

func (*GetEventsRequest) ProtoReflect

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

func (*GetEventsRequest) Reset

func (x *GetEventsRequest) Reset()

func (*GetEventsRequest) String

func (x *GetEventsRequest) String() string

type GetEventsResponse

type GetEventsResponse struct {

	// Types that are assignable to Type:
	//
	//	*GetEventsResponse_ResourceLinksPublished
	//	*GetEventsResponse_ResourceLinksUnpublished
	//	*GetEventsResponse_ResourceLinksSnapshotTaken
	//	*GetEventsResponse_ResourceChanged
	//	*GetEventsResponse_ResourceUpdatePending
	//	*GetEventsResponse_ResourceUpdated
	//	*GetEventsResponse_ResourceRetrievePending
	//	*GetEventsResponse_ResourceRetrieved
	//	*GetEventsResponse_ResourceDeletePending
	//	*GetEventsResponse_ResourceDeleted
	//	*GetEventsResponse_ResourceCreatePending
	//	*GetEventsResponse_ResourceCreated
	//	*GetEventsResponse_ResourceStateSnapshotTaken
	//	*GetEventsResponse_DeviceMetadataUpdatePending
	//	*GetEventsResponse_DeviceMetadataUpdated
	//	*GetEventsResponse_DeviceMetadataSnapshotTaken
	Type isGetEventsResponse_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*GetEventsResponse) Descriptor deprecated

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

Deprecated: Use GetEventsResponse.ProtoReflect.Descriptor instead.

func (*GetEventsResponse) GetDeviceMetadataSnapshotTaken

func (x *GetEventsResponse) GetDeviceMetadataSnapshotTaken() *events.DeviceMetadataSnapshotTaken

func (*GetEventsResponse) GetDeviceMetadataUpdatePending

func (x *GetEventsResponse) GetDeviceMetadataUpdatePending() *events.DeviceMetadataUpdatePending

func (*GetEventsResponse) GetDeviceMetadataUpdated

func (x *GetEventsResponse) GetDeviceMetadataUpdated() *events.DeviceMetadataUpdated

func (*GetEventsResponse) GetResourceChanged

func (x *GetEventsResponse) GetResourceChanged() *events.ResourceChanged

func (*GetEventsResponse) GetResourceCreatePending

func (x *GetEventsResponse) GetResourceCreatePending() *events.ResourceCreatePending

func (*GetEventsResponse) GetResourceCreated

func (x *GetEventsResponse) GetResourceCreated() *events.ResourceCreated

func (*GetEventsResponse) GetResourceDeletePending

func (x *GetEventsResponse) GetResourceDeletePending() *events.ResourceDeletePending

func (*GetEventsResponse) GetResourceDeleted

func (x *GetEventsResponse) GetResourceDeleted() *events.ResourceDeleted

func (*GetEventsResponse) GetResourceLinksPublished

func (x *GetEventsResponse) GetResourceLinksPublished() *events.ResourceLinksPublished

func (*GetEventsResponse) GetResourceLinksSnapshotTaken

func (x *GetEventsResponse) GetResourceLinksSnapshotTaken() *events.ResourceLinksSnapshotTaken

func (*GetEventsResponse) GetResourceLinksUnpublished

func (x *GetEventsResponse) GetResourceLinksUnpublished() *events.ResourceLinksUnpublished

func (*GetEventsResponse) GetResourceRetrievePending

func (x *GetEventsResponse) GetResourceRetrievePending() *events.ResourceRetrievePending

func (*GetEventsResponse) GetResourceRetrieved

func (x *GetEventsResponse) GetResourceRetrieved() *events.ResourceRetrieved

func (*GetEventsResponse) GetResourceStateSnapshotTaken

func (x *GetEventsResponse) GetResourceStateSnapshotTaken() *events.ResourceStateSnapshotTaken

func (*GetEventsResponse) GetResourceUpdatePending

func (x *GetEventsResponse) GetResourceUpdatePending() *events.ResourceUpdatePending

func (*GetEventsResponse) GetResourceUpdated

func (x *GetEventsResponse) GetResourceUpdated() *events.ResourceUpdated

func (*GetEventsResponse) GetType

func (m *GetEventsResponse) GetType() isGetEventsResponse_Type

func (*GetEventsResponse) ProtoMessage

func (*GetEventsResponse) ProtoMessage()

func (*GetEventsResponse) ProtoReflect

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

func (*GetEventsResponse) Reset

func (x *GetEventsResponse) Reset()

func (*GetEventsResponse) String

func (x *GetEventsResponse) String() string

type GetEventsResponse_DeviceMetadataSnapshotTaken

type GetEventsResponse_DeviceMetadataSnapshotTaken struct {
	DeviceMetadataSnapshotTaken *events.DeviceMetadataSnapshotTaken `protobuf:"bytes,16,opt,name=device_metadata_snapshot_taken,json=deviceMetadataSnapshotTaken,proto3,oneof"`
}

type GetEventsResponse_DeviceMetadataUpdatePending

type GetEventsResponse_DeviceMetadataUpdatePending struct {
	DeviceMetadataUpdatePending *events.DeviceMetadataUpdatePending `protobuf:"bytes,14,opt,name=device_metadata_update_pending,json=deviceMetadataUpdatePending,proto3,oneof"`
}

type GetEventsResponse_DeviceMetadataUpdated

type GetEventsResponse_DeviceMetadataUpdated struct {
	DeviceMetadataUpdated *events.DeviceMetadataUpdated `protobuf:"bytes,15,opt,name=device_metadata_updated,json=deviceMetadataUpdated,proto3,oneof"`
}

type GetEventsResponse_ResourceChanged

type GetEventsResponse_ResourceChanged struct {
	ResourceChanged *events.ResourceChanged `protobuf:"bytes,4,opt,name=resource_changed,json=resourceChanged,proto3,oneof"`
}

type GetEventsResponse_ResourceCreatePending

type GetEventsResponse_ResourceCreatePending struct {
	ResourceCreatePending *events.ResourceCreatePending `protobuf:"bytes,11,opt,name=resource_create_pending,json=resourceCreatePending,proto3,oneof"`
}

type GetEventsResponse_ResourceCreated

type GetEventsResponse_ResourceCreated struct {
	ResourceCreated *events.ResourceCreated `protobuf:"bytes,12,opt,name=resource_created,json=resourceCreated,proto3,oneof"`
}

type GetEventsResponse_ResourceDeletePending

type GetEventsResponse_ResourceDeletePending struct {
	ResourceDeletePending *events.ResourceDeletePending `protobuf:"bytes,9,opt,name=resource_delete_pending,json=resourceDeletePending,proto3,oneof"`
}

type GetEventsResponse_ResourceDeleted

type GetEventsResponse_ResourceDeleted struct {
	ResourceDeleted *events.ResourceDeleted `protobuf:"bytes,10,opt,name=resource_deleted,json=resourceDeleted,proto3,oneof"`
}

type GetEventsResponse_ResourceLinksPublished

type GetEventsResponse_ResourceLinksPublished struct {
	ResourceLinksPublished *events.ResourceLinksPublished `protobuf:"bytes,1,opt,name=resource_links_published,json=resourceLinksPublished,proto3,oneof"`
}

type GetEventsResponse_ResourceLinksSnapshotTaken

type GetEventsResponse_ResourceLinksSnapshotTaken struct {
	ResourceLinksSnapshotTaken *events.ResourceLinksSnapshotTaken `protobuf:"bytes,3,opt,name=resource_links_snapshot_taken,json=resourceLinksSnapshotTaken,proto3,oneof"`
}

type GetEventsResponse_ResourceLinksUnpublished

type GetEventsResponse_ResourceLinksUnpublished struct {
	ResourceLinksUnpublished *events.ResourceLinksUnpublished `protobuf:"bytes,2,opt,name=resource_links_unpublished,json=resourceLinksUnpublished,proto3,oneof"`
}

type GetEventsResponse_ResourceRetrievePending

type GetEventsResponse_ResourceRetrievePending struct {
	ResourceRetrievePending *events.ResourceRetrievePending `protobuf:"bytes,7,opt,name=resource_retrieve_pending,json=resourceRetrievePending,proto3,oneof"`
}

type GetEventsResponse_ResourceRetrieved

type GetEventsResponse_ResourceRetrieved struct {
	ResourceRetrieved *events.ResourceRetrieved `protobuf:"bytes,8,opt,name=resource_retrieved,json=resourceRetrieved,proto3,oneof"`
}

type GetEventsResponse_ResourceStateSnapshotTaken

type GetEventsResponse_ResourceStateSnapshotTaken struct {
	ResourceStateSnapshotTaken *events.ResourceStateSnapshotTaken `protobuf:"bytes,13,opt,name=resource_state_snapshot_taken,json=resourceStateSnapshotTaken,proto3,oneof"`
}

type GetEventsResponse_ResourceUpdatePending

type GetEventsResponse_ResourceUpdatePending struct {
	ResourceUpdatePending *events.ResourceUpdatePending `protobuf:"bytes,5,opt,name=resource_update_pending,json=resourceUpdatePending,proto3,oneof"`
}

type GetEventsResponse_ResourceUpdated

type GetEventsResponse_ResourceUpdated struct {
	ResourceUpdated *events.ResourceUpdated `protobuf:"bytes,6,opt,name=resource_updated,json=resourceUpdated,proto3,oneof"`
}

type GetPendingCommandsRequest

type GetPendingCommandsRequest struct {
	CommandFilter []GetPendingCommandsRequest_Command `` /* 162-byte string literal not displayed */
	// Deprecated: Marked as deprecated in grpc-gateway/pb/getPendingCommands.proto.
	HttpResourceIdFilter []string            `protobuf:"bytes,2,rep,name=http_resource_id_filter,json=httpResourceIdFilter,proto3" json:"http_resource_id_filter,omitempty"`
	DeviceIdFilter       []string            `protobuf:"bytes,3,rep,name=device_id_filter,json=deviceIdFilter,proto3" json:"device_id_filter,omitempty"`
	TypeFilter           []string            `protobuf:"bytes,4,rep,name=type_filter,json=typeFilter,proto3" json:"type_filter,omitempty"`
	ResourceIdFilter     []*ResourceIdFilter `protobuf:"bytes,5,rep,name=resource_id_filter,json=resourceIdFilter,proto3" json:"resource_id_filter,omitempty"` // New resource ID filter. For HTTP requests, use it multiple times as a query parameter like "resourceIdFilter={deviceID}{href}".
	// contains filtered or unexported fields
}

func (*GetPendingCommandsRequest) ConvertHTTPResourceIDFilter added in v2.13.0

func (r *GetPendingCommandsRequest) ConvertHTTPResourceIDFilter() []*ResourceIdFilter

func (*GetPendingCommandsRequest) Descriptor deprecated

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

Deprecated: Use GetPendingCommandsRequest.ProtoReflect.Descriptor instead.

func (*GetPendingCommandsRequest) GetCommandFilter

func (*GetPendingCommandsRequest) GetDeviceIdFilter

func (x *GetPendingCommandsRequest) GetDeviceIdFilter() []string

func (*GetPendingCommandsRequest) GetHttpResourceIdFilter deprecated added in v2.13.0

func (x *GetPendingCommandsRequest) GetHttpResourceIdFilter() []string

Deprecated: Marked as deprecated in grpc-gateway/pb/getPendingCommands.proto.

func (*GetPendingCommandsRequest) GetResourceIdFilter

func (x *GetPendingCommandsRequest) GetResourceIdFilter() []*ResourceIdFilter

func (*GetPendingCommandsRequest) GetTypeFilter

func (x *GetPendingCommandsRequest) GetTypeFilter() []string

func (*GetPendingCommandsRequest) ProtoMessage

func (*GetPendingCommandsRequest) ProtoMessage()

func (*GetPendingCommandsRequest) ProtoReflect

func (*GetPendingCommandsRequest) Reset

func (x *GetPendingCommandsRequest) Reset()

func (*GetPendingCommandsRequest) String

func (x *GetPendingCommandsRequest) String() string

type GetPendingCommandsRequest_Command

type GetPendingCommandsRequest_Command int32
const (
	GetPendingCommandsRequest_RESOURCE_CREATE        GetPendingCommandsRequest_Command = 0
	GetPendingCommandsRequest_RESOURCE_RETRIEVE      GetPendingCommandsRequest_Command = 1
	GetPendingCommandsRequest_RESOURCE_UPDATE        GetPendingCommandsRequest_Command = 2
	GetPendingCommandsRequest_RESOURCE_DELETE        GetPendingCommandsRequest_Command = 3
	GetPendingCommandsRequest_DEVICE_METADATA_UPDATE GetPendingCommandsRequest_Command = 4
)

func (GetPendingCommandsRequest_Command) Descriptor

func (GetPendingCommandsRequest_Command) Enum

func (GetPendingCommandsRequest_Command) EnumDescriptor deprecated

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

Deprecated: Use GetPendingCommandsRequest_Command.Descriptor instead.

func (GetPendingCommandsRequest_Command) Number

func (GetPendingCommandsRequest_Command) String

func (GetPendingCommandsRequest_Command) Type

type GetResourceFromDeviceRequest

type GetResourceFromDeviceRequest struct {
	ResourceId        *commands.ResourceId `protobuf:"bytes,1,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	ResourceInterface string               `protobuf:"bytes,2,opt,name=resource_interface,json=resourceInterface,proto3" json:"resource_interface,omitempty"`
	TimeToLive        int64                `protobuf:"varint,3,opt,name=time_to_live,json=timeToLive,proto3" json:"time_to_live,omitempty"` // command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).
	Etag              [][]byte             `protobuf:"bytes,4,rep,name=etag,proto3" json:"etag,omitempty"`                                  // optional
	// contains filtered or unexported fields
}

func (*GetResourceFromDeviceRequest) Descriptor deprecated

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

Deprecated: Use GetResourceFromDeviceRequest.ProtoReflect.Descriptor instead.

func (*GetResourceFromDeviceRequest) GetEtag added in v2.13.0

func (x *GetResourceFromDeviceRequest) GetEtag() [][]byte

func (*GetResourceFromDeviceRequest) GetResourceId

func (x *GetResourceFromDeviceRequest) GetResourceId() *commands.ResourceId

func (*GetResourceFromDeviceRequest) GetResourceInterface

func (x *GetResourceFromDeviceRequest) GetResourceInterface() string

func (*GetResourceFromDeviceRequest) GetTimeToLive

func (x *GetResourceFromDeviceRequest) GetTimeToLive() int64

func (*GetResourceFromDeviceRequest) ProtoMessage

func (*GetResourceFromDeviceRequest) ProtoMessage()

func (*GetResourceFromDeviceRequest) ProtoReflect

func (*GetResourceFromDeviceRequest) Reset

func (x *GetResourceFromDeviceRequest) Reset()

func (*GetResourceFromDeviceRequest) String

func (*GetResourceFromDeviceRequest) ToRACommand

type GetResourceFromDeviceResponse

type GetResourceFromDeviceResponse struct {
	Data *events.ResourceRetrieved `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*GetResourceFromDeviceResponse) Descriptor deprecated

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

Deprecated: Use GetResourceFromDeviceResponse.ProtoReflect.Descriptor instead.

func (*GetResourceFromDeviceResponse) GetData

func (*GetResourceFromDeviceResponse) ProtoMessage

func (*GetResourceFromDeviceResponse) ProtoMessage()

func (*GetResourceFromDeviceResponse) ProtoReflect

func (*GetResourceFromDeviceResponse) Reset

func (x *GetResourceFromDeviceResponse) Reset()

func (*GetResourceFromDeviceResponse) String

type GetResourceLinksRequest

type GetResourceLinksRequest struct {
	TypeFilter     []string `protobuf:"bytes,1,rep,name=type_filter,json=typeFilter,proto3" json:"type_filter,omitempty"`
	DeviceIdFilter []string `protobuf:"bytes,2,rep,name=device_id_filter,json=deviceIdFilter,proto3" json:"device_id_filter,omitempty"`
	// contains filtered or unexported fields
}

func (*GetResourceLinksRequest) Descriptor deprecated

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

Deprecated: Use GetResourceLinksRequest.ProtoReflect.Descriptor instead.

func (*GetResourceLinksRequest) GetDeviceIdFilter

func (x *GetResourceLinksRequest) GetDeviceIdFilter() []string

func (*GetResourceLinksRequest) GetTypeFilter

func (x *GetResourceLinksRequest) GetTypeFilter() []string

func (*GetResourceLinksRequest) ProtoMessage

func (*GetResourceLinksRequest) ProtoMessage()

func (*GetResourceLinksRequest) ProtoReflect

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

func (*GetResourceLinksRequest) Reset

func (x *GetResourceLinksRequest) Reset()

func (*GetResourceLinksRequest) String

func (x *GetResourceLinksRequest) String() string

type GetResourcesRequest

type GetResourcesRequest struct {

	// Deprecated: Marked as deprecated in grpc-gateway/pb/devices.proto.
	HttpResourceIdFilter []string            `protobuf:"bytes,1,rep,name=http_resource_id_filter,json=httpResourceIdFilter,proto3" json:"http_resource_id_filter,omitempty"` // Format: {deviceID}{href}(?etag=abc), e.g., "ae424c58-e517-4494-6de7-583536c48213/oic/d?etag=abc"
	DeviceIdFilter       []string            `protobuf:"bytes,2,rep,name=device_id_filter,json=deviceIdFilter,proto3" json:"device_id_filter,omitempty"`                     // Filter devices by deviceID
	TypeFilter           []string            `protobuf:"bytes,3,rep,name=type_filter,json=typeFilter,proto3" json:"type_filter,omitempty"`                                   // Filter devices by resource types in the oic/d resource
	ResourceIdFilter     []*ResourceIdFilter `protobuf:"bytes,4,rep,name=resource_id_filter,json=resourceIdFilter,proto3" json:"resource_id_filter,omitempty"`               // New resource ID filter. For HTTP requests, use it multiple times as a query parameter like "resourceIdFilter={deviceID}{href}(?etag=abc)"
	// contains filtered or unexported fields
}

func (*GetResourcesRequest) ConvertHTTPResourceIDFilter added in v2.13.0

func (r *GetResourcesRequest) ConvertHTTPResourceIDFilter() []*ResourceIdFilter

func (*GetResourcesRequest) Descriptor deprecated

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

Deprecated: Use GetResourcesRequest.ProtoReflect.Descriptor instead.

func (*GetResourcesRequest) GetDeviceIdFilter

func (x *GetResourcesRequest) GetDeviceIdFilter() []string

func (*GetResourcesRequest) GetHttpResourceIdFilter deprecated added in v2.13.0

func (x *GetResourcesRequest) GetHttpResourceIdFilter() []string

Deprecated: Marked as deprecated in grpc-gateway/pb/devices.proto.

func (*GetResourcesRequest) GetResourceIdFilter

func (x *GetResourcesRequest) GetResourceIdFilter() []*ResourceIdFilter

func (*GetResourcesRequest) GetTypeFilter

func (x *GetResourcesRequest) GetTypeFilter() []string

func (*GetResourcesRequest) ProtoMessage

func (*GetResourcesRequest) ProtoMessage()

func (*GetResourcesRequest) ProtoReflect

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

func (*GetResourcesRequest) Reset

func (x *GetResourcesRequest) Reset()

func (*GetResourcesRequest) String

func (x *GetResourcesRequest) String() string

type GrpcGatewayClient

type GrpcGatewayClient interface {
	// Get all devices
	GetDevices(ctx context.Context, in *GetDevicesRequest, opts ...grpc.CallOption) (GrpcGateway_GetDevicesClient, error)
	// Delete selected devices.
	DeleteDevices(ctx context.Context, in *DeleteDevicesRequest, opts ...grpc.CallOption) (*DeleteDevicesResponse, error)
	// Get resource links of devices.
	GetResourceLinks(ctx context.Context, in *GetResourceLinksRequest, opts ...grpc.CallOption) (GrpcGateway_GetResourceLinksClient, error)
	// Get resource from the device.
	GetResourceFromDevice(ctx context.Context, in *GetResourceFromDeviceRequest, opts ...grpc.CallOption) (*GetResourceFromDeviceResponse, error)
	// Get resources from the resource shadow.
	GetResources(ctx context.Context, in *GetResourcesRequest, opts ...grpc.CallOption) (GrpcGateway_GetResourcesClient, error)
	// Update resource at the device.
	UpdateResource(ctx context.Context, in *UpdateResourceRequest, opts ...grpc.CallOption) (*UpdateResourceResponse, error)
	// When the client creates a subscription.
	// Subscription doesn't guarantee that all events will be sent to the client. The client is responsible for synchronize events.
	SubscribeToEvents(ctx context.Context, opts ...grpc.CallOption) (GrpcGateway_SubscribeToEventsClient, error)
	// Get cloud configuration
	GetHubConfiguration(ctx context.Context, in *HubConfigurationRequest, opts ...grpc.CallOption) (*HubConfigurationResponse, error)
	// Delete resource at the device.
	DeleteResource(ctx context.Context, in *DeleteResourceRequest, opts ...grpc.CallOption) (*DeleteResourceResponse, error)
	// Create resource at the device.
	CreateResource(ctx context.Context, in *CreateResourceRequest, opts ...grpc.CallOption) (*CreateResourceResponse, error)
	// Enables/disables shadow synchronization for device.
	UpdateDeviceMetadata(ctx context.Context, in *UpdateDeviceMetadataRequest, opts ...grpc.CallOption) (*UpdateDeviceMetadataResponse, error)
	// Gets pending commands for devices .
	GetPendingCommands(ctx context.Context, in *GetPendingCommandsRequest, opts ...grpc.CallOption) (GrpcGateway_GetPendingCommandsClient, error)
	// Cancels resource commands.
	CancelPendingCommands(ctx context.Context, in *CancelPendingCommandsRequest, opts ...grpc.CallOption) (*CancelPendingCommandsResponse, error)
	// Cancels device metadata updates.
	CancelPendingMetadataUpdates(ctx context.Context, in *CancelPendingMetadataUpdatesRequest, opts ...grpc.CallOption) (*CancelPendingCommandsResponse, error)
	// Gets metadata of the devices. Is contains online/offline or shadown synchronization status.
	GetDevicesMetadata(ctx context.Context, in *GetDevicesMetadataRequest, opts ...grpc.CallOption) (GrpcGateway_GetDevicesMetadataClient, error)
	// Get events for given combination of device id, resource id and timestamp
	GetEvents(ctx context.Context, in *GetEventsRequest, opts ...grpc.CallOption) (GrpcGateway_GetEventsClient, error)
}

GrpcGatewayClient is the client API for GrpcGateway service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type GrpcGatewayServer

type GrpcGatewayServer interface {
	// Get all devices
	GetDevices(*GetDevicesRequest, GrpcGateway_GetDevicesServer) error
	// Delete selected devices.
	DeleteDevices(context.Context, *DeleteDevicesRequest) (*DeleteDevicesResponse, error)
	// Get resource links of devices.
	GetResourceLinks(*GetResourceLinksRequest, GrpcGateway_GetResourceLinksServer) error
	// Get resource from the device.
	GetResourceFromDevice(context.Context, *GetResourceFromDeviceRequest) (*GetResourceFromDeviceResponse, error)
	// Get resources from the resource shadow.
	GetResources(*GetResourcesRequest, GrpcGateway_GetResourcesServer) error
	// Update resource at the device.
	UpdateResource(context.Context, *UpdateResourceRequest) (*UpdateResourceResponse, error)
	// When the client creates a subscription.
	// Subscription doesn't guarantee that all events will be sent to the client. The client is responsible for synchronize events.
	SubscribeToEvents(GrpcGateway_SubscribeToEventsServer) error
	// Get cloud configuration
	GetHubConfiguration(context.Context, *HubConfigurationRequest) (*HubConfigurationResponse, error)
	// Delete resource at the device.
	DeleteResource(context.Context, *DeleteResourceRequest) (*DeleteResourceResponse, error)
	// Create resource at the device.
	CreateResource(context.Context, *CreateResourceRequest) (*CreateResourceResponse, error)
	// Enables/disables shadow synchronization for device.
	UpdateDeviceMetadata(context.Context, *UpdateDeviceMetadataRequest) (*UpdateDeviceMetadataResponse, error)
	// Gets pending commands for devices .
	GetPendingCommands(*GetPendingCommandsRequest, GrpcGateway_GetPendingCommandsServer) error
	// Cancels resource commands.
	CancelPendingCommands(context.Context, *CancelPendingCommandsRequest) (*CancelPendingCommandsResponse, error)
	// Cancels device metadata updates.
	CancelPendingMetadataUpdates(context.Context, *CancelPendingMetadataUpdatesRequest) (*CancelPendingCommandsResponse, error)
	// Gets metadata of the devices. Is contains online/offline or shadown synchronization status.
	GetDevicesMetadata(*GetDevicesMetadataRequest, GrpcGateway_GetDevicesMetadataServer) error
	// Get events for given combination of device id, resource id and timestamp
	GetEvents(*GetEventsRequest, GrpcGateway_GetEventsServer) error
	// contains filtered or unexported methods
}

GrpcGatewayServer is the server API for GrpcGateway service. All implementations must embed UnimplementedGrpcGatewayServer for forward compatibility

type GrpcGateway_GetDevicesClient

type GrpcGateway_GetDevicesClient interface {
	Recv() (*Device, error)
	grpc.ClientStream
}

type GrpcGateway_GetDevicesMetadataClient

type GrpcGateway_GetDevicesMetadataClient interface {
	Recv() (*events.DeviceMetadataUpdated, error)
	grpc.ClientStream
}

type GrpcGateway_GetDevicesMetadataServer

type GrpcGateway_GetDevicesMetadataServer interface {
	Send(*events.DeviceMetadataUpdated) error
	grpc.ServerStream
}

type GrpcGateway_GetDevicesServer

type GrpcGateway_GetDevicesServer interface {
	Send(*Device) error
	grpc.ServerStream
}

type GrpcGateway_GetEventsClient

type GrpcGateway_GetEventsClient interface {
	Recv() (*GetEventsResponse, error)
	grpc.ClientStream
}

type GrpcGateway_GetEventsServer

type GrpcGateway_GetEventsServer interface {
	Send(*GetEventsResponse) error
	grpc.ServerStream
}

type GrpcGateway_GetPendingCommandsClient

type GrpcGateway_GetPendingCommandsClient interface {
	Recv() (*PendingCommand, error)
	grpc.ClientStream
}

type GrpcGateway_GetPendingCommandsServer

type GrpcGateway_GetPendingCommandsServer interface {
	Send(*PendingCommand) error
	grpc.ServerStream
}

type GrpcGateway_GetResourceLinksClient

type GrpcGateway_GetResourceLinksClient interface {
	Recv() (*events.ResourceLinksPublished, error)
	grpc.ClientStream
}

type GrpcGateway_GetResourceLinksServer

type GrpcGateway_GetResourceLinksServer interface {
	Send(*events.ResourceLinksPublished) error
	grpc.ServerStream
}

type GrpcGateway_GetResourcesClient

type GrpcGateway_GetResourcesClient interface {
	Recv() (*Resource, error)
	grpc.ClientStream
}

type GrpcGateway_GetResourcesServer

type GrpcGateway_GetResourcesServer interface {
	Send(*Resource) error
	grpc.ServerStream
}

type GrpcGateway_SubscribeToEventsClient

type GrpcGateway_SubscribeToEventsClient interface {
	Send(*SubscribeToEvents) error
	Recv() (*Event, error)
	grpc.ClientStream
}

type GrpcGateway_SubscribeToEventsServer

type GrpcGateway_SubscribeToEventsServer interface {
	Send(*Event) error
	Recv() (*SubscribeToEvents, error)
	grpc.ServerStream
}

type HubConfigurationRequest

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

func (*HubConfigurationRequest) Descriptor deprecated

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

Deprecated: Use HubConfigurationRequest.ProtoReflect.Descriptor instead.

func (*HubConfigurationRequest) ProtoMessage

func (*HubConfigurationRequest) ProtoMessage()

func (*HubConfigurationRequest) ProtoReflect

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

func (*HubConfigurationRequest) Reset

func (x *HubConfigurationRequest) Reset()

func (*HubConfigurationRequest) String

func (x *HubConfigurationRequest) String() string

type HubConfigurationResponse

type HubConfigurationResponse struct {

	// provides a current time of server in nanoseconds.
	CurrentTime            int64  `protobuf:"varint,1,opt,name=current_time,json=currentTime,proto3" json:"current_time,omitempty"`
	JwtOwnerClaim          string `protobuf:"bytes,2,opt,name=jwt_owner_claim,json=jwtOwnerClaim,proto3" json:"jwt_owner_claim,omitempty"`
	JwtDeviceIdClaim       string `protobuf:"bytes,3,opt,name=jwt_device_id_claim,json=jwtDeviceIdClaim,proto3" json:"jwt_device_id_claim,omitempty"`
	Id                     string `protobuf:"bytes,4,opt,name=id,proto3" json:"id,omitempty"`
	CoapGateway            string `protobuf:"bytes,5,opt,name=coap_gateway,json=coapGateway,proto3" json:"coap_gateway,omitempty"`
	CertificateAuthorities string `` /* 127-byte string literal not displayed */
	Authority              string `protobuf:"bytes,7,opt,name=authority,proto3" json:"authority,omitempty"`
	// exposes default command time to live in nanoseconds for CreateResource, RetrieveResource, UpdateResource, DeleteResource, and UpdateDeviceMetadata commands when it is not set in the request. 0 - means forever.
	DefaultCommandTimeToLive int64 `` /* 140-byte string literal not displayed */
	// certificate_authority in format https://host:port
	CertificateAuthority string `protobuf:"bytes,9,opt,name=certificate_authority,json=certificateAuthority,proto3" json:"certificate_authority,omitempty"`
	// cfg for UI http-gateway
	HttpGatewayAddress string             `protobuf:"bytes,10,opt,name=http_gateway_address,json=httpGatewayAddress,proto3" json:"http_gateway_address,omitempty"`
	WebOauthClient     *WebOAuthClient    `protobuf:"bytes,11,opt,name=web_oauth_client,json=webOauthClient,proto3" json:"web_oauth_client,omitempty"`
	DeviceOauthClient  *DeviceOAuthClient `protobuf:"bytes,12,opt,name=device_oauth_client,json=deviceOauthClient,proto3" json:"device_oauth_client,omitempty"`
	// build info
	BuildInfo *BuildInfo `protobuf:"bytes,13,opt,name=build_info,json=buildInfo,proto3" json:"build_info,omitempty"`
	// contains filtered or unexported fields
}

func (*HubConfigurationResponse) Descriptor deprecated

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

Deprecated: Use HubConfigurationResponse.ProtoReflect.Descriptor instead.

func (*HubConfigurationResponse) GetAuthority added in v2.5.0

func (x *HubConfigurationResponse) GetAuthority() string

func (*HubConfigurationResponse) GetBuildInfo added in v2.8.0

func (x *HubConfigurationResponse) GetBuildInfo() *BuildInfo

func (*HubConfigurationResponse) GetCertificateAuthorities

func (x *HubConfigurationResponse) GetCertificateAuthorities() string

func (*HubConfigurationResponse) GetCertificateAuthority added in v2.9.0

func (x *HubConfigurationResponse) GetCertificateAuthority() string

func (*HubConfigurationResponse) GetCoapGateway

func (x *HubConfigurationResponse) GetCoapGateway() string

func (*HubConfigurationResponse) GetCurrentTime

func (x *HubConfigurationResponse) GetCurrentTime() int64

func (*HubConfigurationResponse) GetDefaultCommandTimeToLive

func (x *HubConfigurationResponse) GetDefaultCommandTimeToLive() int64

func (*HubConfigurationResponse) GetDeviceOauthClient added in v2.5.0

func (x *HubConfigurationResponse) GetDeviceOauthClient() *DeviceOAuthClient

func (*HubConfigurationResponse) GetHttpGatewayAddress added in v2.5.0

func (x *HubConfigurationResponse) GetHttpGatewayAddress() string

func (*HubConfigurationResponse) GetId

func (x *HubConfigurationResponse) GetId() string

func (*HubConfigurationResponse) GetJwtDeviceIdClaim

func (x *HubConfigurationResponse) GetJwtDeviceIdClaim() string

func (*HubConfigurationResponse) GetJwtOwnerClaim

func (x *HubConfigurationResponse) GetJwtOwnerClaim() string

func (*HubConfigurationResponse) GetWebOauthClient added in v2.5.0

func (x *HubConfigurationResponse) GetWebOauthClient() *WebOAuthClient

func (*HubConfigurationResponse) ProtoMessage

func (*HubConfigurationResponse) ProtoMessage()

func (*HubConfigurationResponse) ProtoReflect

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

func (*HubConfigurationResponse) Reset

func (x *HubConfigurationResponse) Reset()

func (*HubConfigurationResponse) String

func (x *HubConfigurationResponse) String() string

type LocalizedString

type LocalizedString struct {
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	Value    string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func SchemaLocalizedStringToProto

func SchemaLocalizedStringToProto(s device.LocalizedString) *LocalizedString

func SchemaLocalizedStringsToProto

func SchemaLocalizedStringsToProto(s []device.LocalizedString) []*LocalizedString

func (*LocalizedString) Descriptor deprecated

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

Deprecated: Use LocalizedString.ProtoReflect.Descriptor instead.

func (*LocalizedString) GetLanguage

func (x *LocalizedString) GetLanguage() string

func (*LocalizedString) GetValue

func (x *LocalizedString) GetValue() string

func (*LocalizedString) ProtoMessage

func (*LocalizedString) ProtoMessage()

func (*LocalizedString) ProtoReflect

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

func (*LocalizedString) Reset

func (x *LocalizedString) Reset()

func (*LocalizedString) String

func (x *LocalizedString) String() string

func (*LocalizedString) ToSchema

func (l *LocalizedString) ToSchema() device.LocalizedString

type LocalizedStrings

type LocalizedStrings []*LocalizedString

func (LocalizedStrings) ToSchema

func (s LocalizedStrings) ToSchema() []device.LocalizedString

type PendingCommand

type PendingCommand struct {

	// Types that are assignable to Command:
	//
	//	*PendingCommand_ResourceCreatePending
	//	*PendingCommand_ResourceRetrievePending
	//	*PendingCommand_ResourceUpdatePending
	//	*PendingCommand_ResourceDeletePending
	//	*PendingCommand_DeviceMetadataUpdatePending
	Command isPendingCommand_Command `protobuf_oneof:"command"`
	// contains filtered or unexported fields
}

func (*PendingCommand) Descriptor deprecated

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

Deprecated: Use PendingCommand.ProtoReflect.Descriptor instead.

func (*PendingCommand) GetCommand

func (m *PendingCommand) GetCommand() isPendingCommand_Command

func (*PendingCommand) GetDeviceMetadataUpdatePending

func (x *PendingCommand) GetDeviceMetadataUpdatePending() *events.DeviceMetadataUpdatePending

func (*PendingCommand) GetResourceCreatePending

func (x *PendingCommand) GetResourceCreatePending() *events.ResourceCreatePending

func (*PendingCommand) GetResourceDeletePending

func (x *PendingCommand) GetResourceDeletePending() *events.ResourceDeletePending

func (*PendingCommand) GetResourceRetrievePending

func (x *PendingCommand) GetResourceRetrievePending() *events.ResourceRetrievePending

func (*PendingCommand) GetResourceUpdatePending

func (x *PendingCommand) GetResourceUpdatePending() *events.ResourceUpdatePending

func (*PendingCommand) ProtoMessage

func (*PendingCommand) ProtoMessage()

func (*PendingCommand) ProtoReflect

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

func (*PendingCommand) Reset

func (x *PendingCommand) Reset()

func (*PendingCommand) String

func (x *PendingCommand) String() string

type PendingCommand_DeviceMetadataUpdatePending

type PendingCommand_DeviceMetadataUpdatePending struct {
	DeviceMetadataUpdatePending *events.DeviceMetadataUpdatePending `protobuf:"bytes,5,opt,name=device_metadata_update_pending,json=deviceMetadataUpdatePending,proto3,oneof"`
}

type PendingCommand_ResourceCreatePending

type PendingCommand_ResourceCreatePending struct {
	ResourceCreatePending *events.ResourceCreatePending `protobuf:"bytes,1,opt,name=resource_create_pending,json=resourceCreatePending,proto3,oneof"`
}

type PendingCommand_ResourceDeletePending

type PendingCommand_ResourceDeletePending struct {
	ResourceDeletePending *events.ResourceDeletePending `protobuf:"bytes,4,opt,name=resource_delete_pending,json=resourceDeletePending,proto3,oneof"`
}

type PendingCommand_ResourceRetrievePending

type PendingCommand_ResourceRetrievePending struct {
	ResourceRetrievePending *events.ResourceRetrievePending `protobuf:"bytes,2,opt,name=resource_retrieve_pending,json=resourceRetrievePending,proto3,oneof"`
}

type PendingCommand_ResourceUpdatePending

type PendingCommand_ResourceUpdatePending struct {
	ResourceUpdatePending *events.ResourceUpdatePending `protobuf:"bytes,3,opt,name=resource_update_pending,json=resourceUpdatePending,proto3,oneof"`
}

type Resource

type Resource struct {
	Types []string                `protobuf:"bytes,1,rep,name=types,proto3" json:"types,omitempty"`
	Data  *events.ResourceChanged `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Resource) Descriptor deprecated

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

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) GetData

func (x *Resource) GetData() *events.ResourceChanged

func (*Resource) GetTypes

func (x *Resource) GetTypes() []string

func (*Resource) ProtoMessage

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect

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

func (*Resource) Reset

func (x *Resource) Reset()

func (*Resource) String

func (x *Resource) String() string

type ResourceIdFilter added in v2.13.0

type ResourceIdFilter struct {
	ResourceId *commands.ResourceId `protobuf:"bytes,1,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"` // Filter specific resources
	Etag       [][]byte             `protobuf:"bytes,2,rep,name=etag,proto3" json:"etag,omitempty"`                               // Optional; resource_id.{deviceId, href} must not be empty
	// contains filtered or unexported fields
}

func ResourceIdFilterFromString added in v2.13.0

func ResourceIdFilterFromString(filter []string) []*ResourceIdFilter

func (*ResourceIdFilter) Descriptor deprecated added in v2.13.0

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

Deprecated: Use ResourceIdFilter.ProtoReflect.Descriptor instead.

func (*ResourceIdFilter) GetEtag added in v2.13.0

func (x *ResourceIdFilter) GetEtag() [][]byte

func (*ResourceIdFilter) GetResourceId added in v2.13.0

func (x *ResourceIdFilter) GetResourceId() *commands.ResourceId

func (*ResourceIdFilter) ProtoMessage added in v2.13.0

func (*ResourceIdFilter) ProtoMessage()

func (*ResourceIdFilter) ProtoReflect added in v2.13.0

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

func (*ResourceIdFilter) Reset added in v2.13.0

func (x *ResourceIdFilter) Reset()

func (*ResourceIdFilter) String added in v2.13.0

func (x *ResourceIdFilter) String() string

func (*ResourceIdFilter) ToString added in v2.13.0

func (f *ResourceIdFilter) ToString() string

type SubscribeToEvents

type SubscribeToEvents struct {

	// Types that are assignable to Action:
	//
	//	*SubscribeToEvents_CreateSubscription_
	//	*SubscribeToEvents_CancelSubscription_
	Action        isSubscribeToEvents_Action `protobuf_oneof:"action"`
	CorrelationId string                     `protobuf:"bytes,101,opt,name=correlation_id,json=correlationId,proto3" json:"correlation_id,omitempty"` // for pairing request SubscribeToEvents with Event.OperationProcessed
	// contains filtered or unexported fields
}

func (*SubscribeToEvents) Descriptor deprecated

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

Deprecated: Use SubscribeToEvents.ProtoReflect.Descriptor instead.

func (*SubscribeToEvents) GetAction

func (m *SubscribeToEvents) GetAction() isSubscribeToEvents_Action

func (*SubscribeToEvents) GetCancelSubscription

func (x *SubscribeToEvents) GetCancelSubscription() *SubscribeToEvents_CancelSubscription

func (*SubscribeToEvents) GetCorrelationId

func (x *SubscribeToEvents) GetCorrelationId() string

func (*SubscribeToEvents) GetCreateSubscription

func (x *SubscribeToEvents) GetCreateSubscription() *SubscribeToEvents_CreateSubscription

func (*SubscribeToEvents) ProtoMessage

func (*SubscribeToEvents) ProtoMessage()

func (*SubscribeToEvents) ProtoReflect

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

func (*SubscribeToEvents) Reset

func (x *SubscribeToEvents) Reset()

func (*SubscribeToEvents) String

func (x *SubscribeToEvents) String() string

type SubscribeToEvents_CancelSubscription

type SubscribeToEvents_CancelSubscription struct {
	SubscriptionId string `protobuf:"bytes,1,opt,name=subscription_id,json=subscriptionId,proto3" json:"subscription_id,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribeToEvents_CancelSubscription) Descriptor deprecated

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

Deprecated: Use SubscribeToEvents_CancelSubscription.ProtoReflect.Descriptor instead.

func (*SubscribeToEvents_CancelSubscription) GetSubscriptionId

func (x *SubscribeToEvents_CancelSubscription) GetSubscriptionId() string

func (*SubscribeToEvents_CancelSubscription) ProtoMessage

func (*SubscribeToEvents_CancelSubscription) ProtoMessage()

func (*SubscribeToEvents_CancelSubscription) ProtoReflect

func (*SubscribeToEvents_CancelSubscription) Reset

func (*SubscribeToEvents_CancelSubscription) String

type SubscribeToEvents_CancelSubscription_

type SubscribeToEvents_CancelSubscription_ struct {
	CancelSubscription *SubscribeToEvents_CancelSubscription `protobuf:"bytes,2,opt,name=cancel_subscription,json=cancelSubscription,proto3,oneof"`
}

type SubscribeToEvents_CreateSubscription

type SubscribeToEvents_CreateSubscription struct {
	EventFilter []SubscribeToEvents_CreateSubscription_Event `` // array of events. eg: [ REGISTERED, UNREGISTERED  ]
	/* 165-byte string literal not displayed */
	DeviceIdFilter []string `protobuf:"bytes,2,rep,name=device_id_filter,json=deviceIdFilter,proto3" json:"device_id_filter,omitempty"` // array of format {deviceID}. eg [ "ae424c58-e517-4494-6de7-583536c48213" ]
	// Deprecated: Marked as deprecated in grpc-gateway/pb/devices.proto.
	HttpResourceIdFilter []string            `protobuf:"bytes,3,rep,name=http_resource_id_filter,json=httpResourceIdFilter,proto3" json:"http_resource_id_filter,omitempty"` // array of format {deviceID}{href}. eg [ "ae424c58-e517-4494-6de7-583536c48213/oic/d", "ae424c58-e517-4494-6de7-583536c48213/oic/p" ]
	HrefFilter           []string            `protobuf:"bytes,4,rep,name=href_filter,json=hrefFilter,proto3" json:"href_filter,omitempty"`                                   // array of format {href}. eg [ "/oic/d", "/oic/p" ]
	ResourceIdFilter     []*ResourceIdFilter `protobuf:"bytes,5,rep,name=resource_id_filter,json=resourceIdFilter,proto3" json:"resource_id_filter,omitempty"`
	// contains filtered or unexported fields
}

If you want to subscribe to all events, leave the filter unset. Use the event_filter in conjunction with other filters to filter events by type. If event_filter is set, only events with the specified type will be received. To filter devices, use the device_id_filter. It follows the format {deviceID[0]+"/"+"*", deviceID[1]+"/"+"*", ...}. To filter resources, use the href_filter. It follows the format {"*"+href[0], "*"+href[1], ...}. When both device_id_filter and href_filter are set, the href_filter is applied to each device. {deviceID[0]+href[0], ..., deviceID[1]+href[0], ...}. To filter resources of specific devices, use the resource_id_filter. You can use either device_id_filter or resource_id_filter or both. In this case, the result is the union of both filters. Certain filters perform a logical "or" operation among the elements of the filter.

func (*SubscribeToEvents_CreateSubscription) ConvertHTTPResourceIDFilter added in v2.13.0

func (c *SubscribeToEvents_CreateSubscription) ConvertHTTPResourceIDFilter() []*ResourceIdFilter

func (*SubscribeToEvents_CreateSubscription) Descriptor deprecated

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

Deprecated: Use SubscribeToEvents_CreateSubscription.ProtoReflect.Descriptor instead.

func (*SubscribeToEvents_CreateSubscription) GetDeviceIdFilter

func (x *SubscribeToEvents_CreateSubscription) GetDeviceIdFilter() []string

func (*SubscribeToEvents_CreateSubscription) GetEventFilter

func (*SubscribeToEvents_CreateSubscription) GetHrefFilter added in v2.8.0

func (x *SubscribeToEvents_CreateSubscription) GetHrefFilter() []string

func (*SubscribeToEvents_CreateSubscription) GetHttpResourceIdFilter deprecated added in v2.13.0

func (x *SubscribeToEvents_CreateSubscription) GetHttpResourceIdFilter() []string

Deprecated: Marked as deprecated in grpc-gateway/pb/devices.proto.

func (*SubscribeToEvents_CreateSubscription) GetResourceIdFilter

func (x *SubscribeToEvents_CreateSubscription) GetResourceIdFilter() []*ResourceIdFilter

func (*SubscribeToEvents_CreateSubscription) ProtoMessage

func (*SubscribeToEvents_CreateSubscription) ProtoMessage()

func (*SubscribeToEvents_CreateSubscription) ProtoReflect

func (*SubscribeToEvents_CreateSubscription) Reset

func (*SubscribeToEvents_CreateSubscription) String

type SubscribeToEvents_CreateSubscription_

type SubscribeToEvents_CreateSubscription_ struct {
	CreateSubscription *SubscribeToEvents_CreateSubscription `protobuf:"bytes,1,opt,name=create_subscription,json=createSubscription,proto3,oneof"`
}

type SubscribeToEvents_CreateSubscription_Event

type SubscribeToEvents_CreateSubscription_Event int32
const (
	SubscribeToEvents_CreateSubscription_REGISTERED                     SubscribeToEvents_CreateSubscription_Event = 0
	SubscribeToEvents_CreateSubscription_UNREGISTERED                   SubscribeToEvents_CreateSubscription_Event = 1
	SubscribeToEvents_CreateSubscription_DEVICE_METADATA_UPDATED        SubscribeToEvents_CreateSubscription_Event = 4
	SubscribeToEvents_CreateSubscription_DEVICE_METADATA_UPDATE_PENDING SubscribeToEvents_CreateSubscription_Event = 5
	SubscribeToEvents_CreateSubscription_RESOURCE_PUBLISHED             SubscribeToEvents_CreateSubscription_Event = 6
	SubscribeToEvents_CreateSubscription_RESOURCE_UNPUBLISHED           SubscribeToEvents_CreateSubscription_Event = 7
	SubscribeToEvents_CreateSubscription_RESOURCE_UPDATE_PENDING        SubscribeToEvents_CreateSubscription_Event = 8
	SubscribeToEvents_CreateSubscription_RESOURCE_UPDATED               SubscribeToEvents_CreateSubscription_Event = 9
	SubscribeToEvents_CreateSubscription_RESOURCE_RETRIEVE_PENDING      SubscribeToEvents_CreateSubscription_Event = 10
	SubscribeToEvents_CreateSubscription_RESOURCE_RETRIEVED             SubscribeToEvents_CreateSubscription_Event = 11
	SubscribeToEvents_CreateSubscription_RESOURCE_DELETE_PENDING        SubscribeToEvents_CreateSubscription_Event = 12
	SubscribeToEvents_CreateSubscription_RESOURCE_DELETED               SubscribeToEvents_CreateSubscription_Event = 13
	SubscribeToEvents_CreateSubscription_RESOURCE_CREATE_PENDING        SubscribeToEvents_CreateSubscription_Event = 14
	SubscribeToEvents_CreateSubscription_RESOURCE_CREATED               SubscribeToEvents_CreateSubscription_Event = 15
	SubscribeToEvents_CreateSubscription_RESOURCE_CHANGED               SubscribeToEvents_CreateSubscription_Event = 16
)

func (SubscribeToEvents_CreateSubscription_Event) Descriptor

func (SubscribeToEvents_CreateSubscription_Event) Enum

func (SubscribeToEvents_CreateSubscription_Event) EnumDescriptor deprecated

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

Deprecated: Use SubscribeToEvents_CreateSubscription_Event.Descriptor instead.

func (SubscribeToEvents_CreateSubscription_Event) Number

func (SubscribeToEvents_CreateSubscription_Event) String

func (SubscribeToEvents_CreateSubscription_Event) Type

type UnimplementedGrpcGatewayServer

type UnimplementedGrpcGatewayServer struct {
}

UnimplementedGrpcGatewayServer must be embedded to have forward compatible implementations.

func (UnimplementedGrpcGatewayServer) CreateResource

func (UnimplementedGrpcGatewayServer) DeleteDevices

func (UnimplementedGrpcGatewayServer) DeleteResource

func (UnimplementedGrpcGatewayServer) GetDevices

func (UnimplementedGrpcGatewayServer) GetEvents

func (UnimplementedGrpcGatewayServer) GetHubConfiguration

func (UnimplementedGrpcGatewayServer) GetResources

func (UnimplementedGrpcGatewayServer) SubscribeToEvents

func (UnimplementedGrpcGatewayServer) UpdateResource

type UnsafeGrpcGatewayServer

type UnsafeGrpcGatewayServer interface {
	// contains filtered or unexported methods
}

UnsafeGrpcGatewayServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to GrpcGatewayServer will result in compilation errors.

type UpdateDeviceMetadataRequest

type UpdateDeviceMetadataRequest struct {
	DeviceId                 string `protobuf:"bytes,1,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	TwinEnabled              bool   `protobuf:"varint,4,opt,name=twin_enabled,json=twinEnabled,proto3" json:"twin_enabled,omitempty"`
	TwinForceSynchronization bool   `` // force synchronization IoT hub with the device resources and set twin_enabled to true. Use to address potential synchronization issues and prevent operational discrepancies.
	/* 136-byte string literal not displayed */
	TimeToLive int64 `protobuf:"varint,3,opt,name=time_to_live,json=timeToLive,proto3" json:"time_to_live,omitempty"` // command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).
	// contains filtered or unexported fields
}

func (*UpdateDeviceMetadataRequest) Descriptor deprecated

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

Deprecated: Use UpdateDeviceMetadataRequest.ProtoReflect.Descriptor instead.

func (*UpdateDeviceMetadataRequest) GetDeviceId

func (x *UpdateDeviceMetadataRequest) GetDeviceId() string

func (*UpdateDeviceMetadataRequest) GetTimeToLive

func (x *UpdateDeviceMetadataRequest) GetTimeToLive() int64

func (*UpdateDeviceMetadataRequest) GetTwinEnabled added in v2.6.0

func (x *UpdateDeviceMetadataRequest) GetTwinEnabled() bool

func (*UpdateDeviceMetadataRequest) GetTwinForceSynchronization added in v2.10.0

func (x *UpdateDeviceMetadataRequest) GetTwinForceSynchronization() bool

func (*UpdateDeviceMetadataRequest) ProtoMessage

func (*UpdateDeviceMetadataRequest) ProtoMessage()

func (*UpdateDeviceMetadataRequest) ProtoReflect

func (*UpdateDeviceMetadataRequest) Reset

func (x *UpdateDeviceMetadataRequest) Reset()

func (*UpdateDeviceMetadataRequest) String

func (x *UpdateDeviceMetadataRequest) String() string

func (*UpdateDeviceMetadataRequest) ToRACommand

type UpdateDeviceMetadataResponse

type UpdateDeviceMetadataResponse struct {
	Data *events.DeviceMetadataUpdated `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateDeviceMetadataResponse) Descriptor deprecated

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

Deprecated: Use UpdateDeviceMetadataResponse.ProtoReflect.Descriptor instead.

func (*UpdateDeviceMetadataResponse) GetData

func (*UpdateDeviceMetadataResponse) ProtoMessage

func (*UpdateDeviceMetadataResponse) ProtoMessage()

func (*UpdateDeviceMetadataResponse) ProtoReflect

func (*UpdateDeviceMetadataResponse) Reset

func (x *UpdateDeviceMetadataResponse) Reset()

func (*UpdateDeviceMetadataResponse) String

type UpdateResourceRequest

type UpdateResourceRequest struct {
	ResourceId        *commands.ResourceId `protobuf:"bytes,1,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	ResourceInterface string               `protobuf:"bytes,3,opt,name=resource_interface,json=resourceInterface,proto3" json:"resource_interface,omitempty"`
	TimeToLive        int64                `protobuf:"varint,4,opt,name=time_to_live,json=timeToLive,proto3" json:"time_to_live,omitempty"` // command validity in nanoseconds. 0 means forever and minimal value is 100000000 (100ms).
	Content           *Content             `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateResourceRequest) Descriptor deprecated

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

Deprecated: Use UpdateResourceRequest.ProtoReflect.Descriptor instead.

func (*UpdateResourceRequest) GetContent

func (x *UpdateResourceRequest) GetContent() *Content

func (*UpdateResourceRequest) GetResourceId

func (x *UpdateResourceRequest) GetResourceId() *commands.ResourceId

func (*UpdateResourceRequest) GetResourceInterface

func (x *UpdateResourceRequest) GetResourceInterface() string

func (*UpdateResourceRequest) GetTimeToLive

func (x *UpdateResourceRequest) GetTimeToLive() int64

func (*UpdateResourceRequest) ProtoMessage

func (*UpdateResourceRequest) ProtoMessage()

func (*UpdateResourceRequest) ProtoReflect

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

func (*UpdateResourceRequest) Reset

func (x *UpdateResourceRequest) Reset()

func (*UpdateResourceRequest) String

func (x *UpdateResourceRequest) String() string

func (*UpdateResourceRequest) ToRACommand

type UpdateResourceResponse

type UpdateResourceResponse struct {
	Data *events.ResourceUpdated `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateResourceResponse) Descriptor deprecated

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

Deprecated: Use UpdateResourceResponse.ProtoReflect.Descriptor instead.

func (*UpdateResourceResponse) GetData

func (*UpdateResourceResponse) ProtoMessage

func (*UpdateResourceResponse) ProtoMessage()

func (*UpdateResourceResponse) ProtoReflect

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

func (*UpdateResourceResponse) Reset

func (x *UpdateResourceResponse) Reset()

func (*UpdateResourceResponse) String

func (x *UpdateResourceResponse) String() string

type WebOAuthClient added in v2.5.0

type WebOAuthClient struct {
	ClientId string   `protobuf:"bytes,1,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty" yaml:"clientID"` // @gotags: yaml:"clientID"
	Audience string   `protobuf:"bytes,2,opt,name=audience,proto3" json:"audience,omitempty"`
	Scopes   []string `protobuf:"bytes,3,rep,name=scopes,proto3" json:"scopes,omitempty"`
	// contains filtered or unexported fields
}

func (*WebOAuthClient) Clone added in v2.7.4

func (r *WebOAuthClient) Clone() *WebOAuthClient

func (*WebOAuthClient) Descriptor deprecated added in v2.5.0

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

Deprecated: Use WebOAuthClient.ProtoReflect.Descriptor instead.

func (*WebOAuthClient) GetAudience added in v2.5.0

func (x *WebOAuthClient) GetAudience() string

func (*WebOAuthClient) GetClientId added in v2.5.0

func (x *WebOAuthClient) GetClientId() string

func (*WebOAuthClient) GetScopes added in v2.5.0

func (x *WebOAuthClient) GetScopes() []string

func (*WebOAuthClient) ProtoMessage added in v2.5.0

func (*WebOAuthClient) ProtoMessage()

func (*WebOAuthClient) ProtoReflect added in v2.5.0

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

func (*WebOAuthClient) Reset added in v2.5.0

func (x *WebOAuthClient) Reset()

func (*WebOAuthClient) String added in v2.5.0

func (x *WebOAuthClient) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL