google-cloud-iot-v1 0.9.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -143
  3. data/lib/google/cloud/iot/v1/version.rb +3 -8
  4. metadata +15 -203
  5. data/.yardopts +0 -12
  6. data/AUTHENTICATION.md +0 -122
  7. data/lib/google/cloud/iot/v1/device_manager/client.rb +0 -2316
  8. data/lib/google/cloud/iot/v1/device_manager/credentials.rb +0 -52
  9. data/lib/google/cloud/iot/v1/device_manager/paths.rb +0 -90
  10. data/lib/google/cloud/iot/v1/device_manager/rest/client.rb +0 -2157
  11. data/lib/google/cloud/iot/v1/device_manager/rest/service_stub.rb +0 -1293
  12. data/lib/google/cloud/iot/v1/device_manager/rest.rb +0 -52
  13. data/lib/google/cloud/iot/v1/device_manager.rb +0 -55
  14. data/lib/google/cloud/iot/v1/device_manager_pb.rb +0 -77
  15. data/lib/google/cloud/iot/v1/device_manager_services_pb.rb +0 -102
  16. data/lib/google/cloud/iot/v1/resources_pb.rb +0 -68
  17. data/lib/google/cloud/iot/v1/rest.rb +0 -37
  18. data/lib/google/cloud/iot/v1.rb +0 -45
  19. data/lib/google-cloud-iot-v1.rb +0 -21
  20. data/proto_docs/README.md +0 -4
  21. data/proto_docs/google/api/client.rb +0 -395
  22. data/proto_docs/google/api/field_behavior.rb +0 -85
  23. data/proto_docs/google/api/launch_stage.rb +0 -71
  24. data/proto_docs/google/api/resource.rb +0 -222
  25. data/proto_docs/google/cloud/iot/v1/device_manager.rb +0 -399
  26. data/proto_docs/google/cloud/iot/v1/resources.rb +0 -517
  27. data/proto_docs/google/iam/v1/iam_policy.rb +0 -87
  28. data/proto_docs/google/iam/v1/options.rb +0 -50
  29. data/proto_docs/google/iam/v1/policy.rb +0 -426
  30. data/proto_docs/google/protobuf/any.rb +0 -144
  31. data/proto_docs/google/protobuf/duration.rb +0 -98
  32. data/proto_docs/google/protobuf/empty.rb +0 -34
  33. data/proto_docs/google/protobuf/field_mask.rb +0 -229
  34. data/proto_docs/google/protobuf/timestamp.rb +0 -127
  35. data/proto_docs/google/rpc/status.rb +0 -48
  36. data/proto_docs/google/type/expr.rb +0 -75
@@ -1,222 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2020 Google LLC
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # https://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
-
20
- module Google
21
- module Api
22
- # A simple descriptor of a resource type.
23
- #
24
- # ResourceDescriptor annotates a resource message (either by means of a
25
- # protobuf annotation or use in the service config), and associates the
26
- # resource's schema, the resource type, and the pattern of the resource name.
27
- #
28
- # Example:
29
- #
30
- # message Topic {
31
- # // Indicates this message defines a resource schema.
32
- # // Declares the resource type in the format of {service}/{kind}.
33
- # // For Kubernetes resources, the format is {api group}/{kind}.
34
- # option (google.api.resource) = {
35
- # type: "pubsub.googleapis.com/Topic"
36
- # pattern: "projects/{project}/topics/{topic}"
37
- # };
38
- # }
39
- #
40
- # The ResourceDescriptor Yaml config will look like:
41
- #
42
- # resources:
43
- # - type: "pubsub.googleapis.com/Topic"
44
- # pattern: "projects/{project}/topics/{topic}"
45
- #
46
- # Sometimes, resources have multiple patterns, typically because they can
47
- # live under multiple parents.
48
- #
49
- # Example:
50
- #
51
- # message LogEntry {
52
- # option (google.api.resource) = {
53
- # type: "logging.googleapis.com/LogEntry"
54
- # pattern: "projects/{project}/logs/{log}"
55
- # pattern: "folders/{folder}/logs/{log}"
56
- # pattern: "organizations/{organization}/logs/{log}"
57
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
- # };
59
- # }
60
- #
61
- # The ResourceDescriptor Yaml config will look like:
62
- #
63
- # resources:
64
- # - type: 'logging.googleapis.com/LogEntry'
65
- # pattern: "projects/{project}/logs/{log}"
66
- # pattern: "folders/{folder}/logs/{log}"
67
- # pattern: "organizations/{organization}/logs/{log}"
68
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
- # @!attribute [rw] type
70
- # @return [::String]
71
- # The resource type. It must be in the format of
72
- # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
- # singular and must not include version numbers.
74
- #
75
- # Example: `storage.googleapis.com/Bucket`
76
- #
77
- # The value of the resource_type_kind must follow the regular expression
78
- # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
- # should use PascalCase (UpperCamelCase). The maximum number of
80
- # characters allowed for the `resource_type_kind` is 100.
81
- # @!attribute [rw] pattern
82
- # @return [::Array<::String>]
83
- # Optional. The relative resource name pattern associated with this resource
84
- # type. The DNS prefix of the full resource name shouldn't be specified here.
85
- #
86
- # The path pattern must follow the syntax, which aligns with HTTP binding
87
- # syntax:
88
- #
89
- # Template = Segment { "/" Segment } ;
90
- # Segment = LITERAL | Variable ;
91
- # Variable = "{" LITERAL "}" ;
92
- #
93
- # Examples:
94
- #
95
- # - "projects/\\{project}/topics/\\{topic}"
96
- # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
- #
98
- # The components in braces correspond to the IDs for each resource in the
99
- # hierarchy. It is expected that, if multiple patterns are provided,
100
- # the same component name (e.g. "project") refers to IDs of the same
101
- # type of resource.
102
- # @!attribute [rw] name_field
103
- # @return [::String]
104
- # Optional. The field on the resource that designates the resource name
105
- # field. If omitted, this is assumed to be "name".
106
- # @!attribute [rw] history
107
- # @return [::Google::Api::ResourceDescriptor::History]
108
- # Optional. The historical or future-looking state of the resource pattern.
109
- #
110
- # Example:
111
- #
112
- # // The InspectTemplate message originally only supported resource
113
- # // names with organization, and project was added later.
114
- # message InspectTemplate {
115
- # option (google.api.resource) = {
116
- # type: "dlp.googleapis.com/InspectTemplate"
117
- # pattern:
118
- # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
- # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
- # history: ORIGINALLY_SINGLE_PATTERN
121
- # };
122
- # }
123
- # @!attribute [rw] plural
124
- # @return [::String]
125
- # The plural name used in the resource name and permission names, such as
126
- # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
- # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
- # concept of the `plural` field in k8s CRD spec
129
- # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
- #
131
- # Note: The plural form is required even for singleton resources. See
132
- # https://aip.dev/156
133
- # @!attribute [rw] singular
134
- # @return [::String]
135
- # The same concept of the `singular` field in k8s CRD spec
136
- # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
137
- # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
138
- # @!attribute [rw] style
139
- # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
140
- # Style flag(s) for this resource.
141
- # These indicate that a resource is expected to conform to a given
142
- # style. See the specific style flags for additional information.
143
- class ResourceDescriptor
144
- include ::Google::Protobuf::MessageExts
145
- extend ::Google::Protobuf::MessageExts::ClassMethods
146
-
147
- # A description of the historical or future-looking state of the
148
- # resource pattern.
149
- module History
150
- # The "unset" value.
151
- HISTORY_UNSPECIFIED = 0
152
-
153
- # The resource originally had one pattern and launched as such, and
154
- # additional patterns were added later.
155
- ORIGINALLY_SINGLE_PATTERN = 1
156
-
157
- # The resource has one pattern, but the API owner expects to add more
158
- # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
159
- # that from being necessary once there are multiple patterns.)
160
- FUTURE_MULTI_PATTERN = 2
161
- end
162
-
163
- # A flag representing a specific style that a resource claims to conform to.
164
- module Style
165
- # The unspecified value. Do not use.
166
- STYLE_UNSPECIFIED = 0
167
-
168
- # This resource is intended to be "declarative-friendly".
169
- #
170
- # Declarative-friendly resources must be more strictly consistent, and
171
- # setting this to true communicates to tools that this resource should
172
- # adhere to declarative-friendly expectations.
173
- #
174
- # Note: This is used by the API linter (linter.aip.dev) to enable
175
- # additional checks.
176
- DECLARATIVE_FRIENDLY = 1
177
- end
178
- end
179
-
180
- # Defines a proto annotation that describes a string field that refers to
181
- # an API resource.
182
- # @!attribute [rw] type
183
- # @return [::String]
184
- # The resource type that the annotated field references.
185
- #
186
- # Example:
187
- #
188
- # message Subscription {
189
- # string topic = 2 [(google.api.resource_reference) = {
190
- # type: "pubsub.googleapis.com/Topic"
191
- # }];
192
- # }
193
- #
194
- # Occasionally, a field may reference an arbitrary resource. In this case,
195
- # APIs use the special value * in their resource reference.
196
- #
197
- # Example:
198
- #
199
- # message GetIamPolicyRequest {
200
- # string resource = 2 [(google.api.resource_reference) = {
201
- # type: "*"
202
- # }];
203
- # }
204
- # @!attribute [rw] child_type
205
- # @return [::String]
206
- # The resource type of a child collection that the annotated field
207
- # references. This is useful for annotating the `parent` field that
208
- # doesn't have a fixed resource type.
209
- #
210
- # Example:
211
- #
212
- # message ListLogEntriesRequest {
213
- # string parent = 1 [(google.api.resource_reference) = {
214
- # child_type: "logging.googleapis.com/LogEntry"
215
- # };
216
- # }
217
- class ResourceReference
218
- include ::Google::Protobuf::MessageExts
219
- extend ::Google::Protobuf::MessageExts::ClassMethods
220
- end
221
- end
222
- end
@@ -1,399 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2020 Google LLC
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # https://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
-
20
- module Google
21
- module Cloud
22
- module Iot
23
- module V1
24
- # Request for `CreateDeviceRegistry`.
25
- # @!attribute [rw] parent
26
- # @return [::String]
27
- # Required. The project and cloud region where this device registry must be created.
28
- # For example, `projects/example-project/locations/us-central1`.
29
- # @!attribute [rw] device_registry
30
- # @return [::Google::Cloud::Iot::V1::DeviceRegistry]
31
- # Required. The device registry. The field `name` must be empty. The server will
32
- # generate that field from the device registry `id` provided and the
33
- # `parent` field.
34
- class CreateDeviceRegistryRequest
35
- include ::Google::Protobuf::MessageExts
36
- extend ::Google::Protobuf::MessageExts::ClassMethods
37
- end
38
-
39
- # Request for `GetDeviceRegistry`.
40
- # @!attribute [rw] name
41
- # @return [::String]
42
- # Required. The name of the device registry. For example,
43
- # `projects/example-project/locations/us-central1/registries/my-registry`.
44
- class GetDeviceRegistryRequest
45
- include ::Google::Protobuf::MessageExts
46
- extend ::Google::Protobuf::MessageExts::ClassMethods
47
- end
48
-
49
- # Request for `DeleteDeviceRegistry`.
50
- # @!attribute [rw] name
51
- # @return [::String]
52
- # Required. The name of the device registry. For example,
53
- # `projects/example-project/locations/us-central1/registries/my-registry`.
54
- class DeleteDeviceRegistryRequest
55
- include ::Google::Protobuf::MessageExts
56
- extend ::Google::Protobuf::MessageExts::ClassMethods
57
- end
58
-
59
- # Request for `UpdateDeviceRegistry`.
60
- # @!attribute [rw] device_registry
61
- # @return [::Google::Cloud::Iot::V1::DeviceRegistry]
62
- # Required. The new values for the device registry. The `id` field must be empty, and
63
- # the `name` field must indicate the path of the resource. For example,
64
- # `projects/example-project/locations/us-central1/registries/my-registry`.
65
- # @!attribute [rw] update_mask
66
- # @return [::Google::Protobuf::FieldMask]
67
- # Required. Only updates the `device_registry` fields indicated by this mask.
68
- # The field mask must not be empty, and it must not contain fields that
69
- # are immutable or only set by the server.
70
- # Mutable top-level fields: `event_notification_config`, `http_config`,
71
- # `mqtt_config`, and `state_notification_config`.
72
- class UpdateDeviceRegistryRequest
73
- include ::Google::Protobuf::MessageExts
74
- extend ::Google::Protobuf::MessageExts::ClassMethods
75
- end
76
-
77
- # Request for `ListDeviceRegistries`.
78
- # @!attribute [rw] parent
79
- # @return [::String]
80
- # Required. The project and cloud region path. For example,
81
- # `projects/example-project/locations/us-central1`.
82
- # @!attribute [rw] page_size
83
- # @return [::Integer]
84
- # The maximum number of registries to return in the response. If this value
85
- # is zero, the service will select a default size. A call may return fewer
86
- # objects than requested. A non-empty `next_page_token` in the response
87
- # indicates that more data is available.
88
- # @!attribute [rw] page_token
89
- # @return [::String]
90
- # The value returned by the last `ListDeviceRegistriesResponse`; indicates
91
- # that this is a continuation of a prior `ListDeviceRegistries` call and
92
- # the system should return the next page of data.
93
- class ListDeviceRegistriesRequest
94
- include ::Google::Protobuf::MessageExts
95
- extend ::Google::Protobuf::MessageExts::ClassMethods
96
- end
97
-
98
- # Response for `ListDeviceRegistries`.
99
- # @!attribute [rw] device_registries
100
- # @return [::Array<::Google::Cloud::Iot::V1::DeviceRegistry>]
101
- # The registries that matched the query.
102
- # @!attribute [rw] next_page_token
103
- # @return [::String]
104
- # If not empty, indicates that there may be more registries that match the
105
- # request; this value should be passed in a new
106
- # `ListDeviceRegistriesRequest`.
107
- class ListDeviceRegistriesResponse
108
- include ::Google::Protobuf::MessageExts
109
- extend ::Google::Protobuf::MessageExts::ClassMethods
110
- end
111
-
112
- # Request for `CreateDevice`.
113
- # @!attribute [rw] parent
114
- # @return [::String]
115
- # Required. The name of the device registry where this device should be created.
116
- # For example,
117
- # `projects/example-project/locations/us-central1/registries/my-registry`.
118
- # @!attribute [rw] device
119
- # @return [::Google::Cloud::Iot::V1::Device]
120
- # Required. The device registration details. The field `name` must be empty. The server
121
- # generates `name` from the device registry `id` and the
122
- # `parent` field.
123
- class CreateDeviceRequest
124
- include ::Google::Protobuf::MessageExts
125
- extend ::Google::Protobuf::MessageExts::ClassMethods
126
- end
127
-
128
- # Request for `GetDevice`.
129
- # @!attribute [rw] name
130
- # @return [::String]
131
- # Required. The name of the device. For example,
132
- # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
133
- # `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
134
- # @!attribute [rw] field_mask
135
- # @return [::Google::Protobuf::FieldMask]
136
- # The fields of the `Device` resource to be returned in the response. If the
137
- # field mask is unset or empty, all fields are returned. Fields have to be
138
- # provided in snake_case format, for example: `last_heartbeat_time`.
139
- class GetDeviceRequest
140
- include ::Google::Protobuf::MessageExts
141
- extend ::Google::Protobuf::MessageExts::ClassMethods
142
- end
143
-
144
- # Request for `UpdateDevice`.
145
- # @!attribute [rw] device
146
- # @return [::Google::Cloud::Iot::V1::Device]
147
- # Required. The new values for the device. The `id` and `num_id` fields must
148
- # be empty, and the field `name` must specify the name path. For example,
149
- # `projects/p0/locations/us-central1/registries/registry0/devices/device0`or
150
- # `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
151
- # @!attribute [rw] update_mask
152
- # @return [::Google::Protobuf::FieldMask]
153
- # Required. Only updates the `device` fields indicated by this mask.
154
- # The field mask must not be empty, and it must not contain fields that
155
- # are immutable or only set by the server.
156
- # Mutable top-level fields: `credentials`, `blocked`, and `metadata`
157
- class UpdateDeviceRequest
158
- include ::Google::Protobuf::MessageExts
159
- extend ::Google::Protobuf::MessageExts::ClassMethods
160
- end
161
-
162
- # Request for `DeleteDevice`.
163
- # @!attribute [rw] name
164
- # @return [::String]
165
- # Required. The name of the device. For example,
166
- # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
167
- # `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
168
- class DeleteDeviceRequest
169
- include ::Google::Protobuf::MessageExts
170
- extend ::Google::Protobuf::MessageExts::ClassMethods
171
- end
172
-
173
- # Request for `ListDevices`.
174
- # @!attribute [rw] parent
175
- # @return [::String]
176
- # Required. The device registry path. Required. For example,
177
- # `projects/my-project/locations/us-central1/registries/my-registry`.
178
- # @!attribute [rw] device_num_ids
179
- # @return [::Array<::Integer>]
180
- # A list of device numeric IDs. If empty, this field is ignored. Maximum
181
- # IDs: 10,000.
182
- # @!attribute [rw] device_ids
183
- # @return [::Array<::String>]
184
- # A list of device string IDs. For example, `['device0', 'device12']`.
185
- # If empty, this field is ignored. Maximum IDs: 10,000
186
- # @!attribute [rw] field_mask
187
- # @return [::Google::Protobuf::FieldMask]
188
- # The fields of the `Device` resource to be returned in the response. The
189
- # fields `id` and `num_id` are always returned, along with any
190
- # other fields specified in snake_case format, for example:
191
- # `last_heartbeat_time`.
192
- # @!attribute [rw] gateway_list_options
193
- # @return [::Google::Cloud::Iot::V1::GatewayListOptions]
194
- # Options related to gateways.
195
- # @!attribute [rw] page_size
196
- # @return [::Integer]
197
- # The maximum number of devices to return in the response. If this value
198
- # is zero, the service will select a default size. A call may return fewer
199
- # objects than requested. A non-empty `next_page_token` in the response
200
- # indicates that more data is available.
201
- # @!attribute [rw] page_token
202
- # @return [::String]
203
- # The value returned by the last `ListDevicesResponse`; indicates
204
- # that this is a continuation of a prior `ListDevices` call and
205
- # the system should return the next page of data.
206
- class ListDevicesRequest
207
- include ::Google::Protobuf::MessageExts
208
- extend ::Google::Protobuf::MessageExts::ClassMethods
209
- end
210
-
211
- # Options for limiting the list based on gateway type and associations.
212
- # @!attribute [rw] gateway_type
213
- # @return [::Google::Cloud::Iot::V1::GatewayType]
214
- # If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY`
215
- # is specified, only non-gateway devices are returned. If
216
- # `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.
217
- # @!attribute [rw] associations_gateway_id
218
- # @return [::String]
219
- # If set, only devices associated with the specified gateway are returned.
220
- # The gateway ID can be numeric (`num_id`) or the user-defined string
221
- # (`id`). For example, if `123` is specified, only devices bound to the
222
- # gateway with `num_id` 123 are returned.
223
- # @!attribute [rw] associations_device_id
224
- # @return [::String]
225
- # If set, returns only the gateways with which the specified device is
226
- # associated. The device ID can be numeric (`num_id`) or the user-defined
227
- # string (`id`). For example, if `456` is specified, returns only the
228
- # gateways to which the device with `num_id` 456 is bound.
229
- class GatewayListOptions
230
- include ::Google::Protobuf::MessageExts
231
- extend ::Google::Protobuf::MessageExts::ClassMethods
232
- end
233
-
234
- # Response for `ListDevices`.
235
- # @!attribute [rw] devices
236
- # @return [::Array<::Google::Cloud::Iot::V1::Device>]
237
- # The devices that match the request.
238
- # @!attribute [rw] next_page_token
239
- # @return [::String]
240
- # If not empty, indicates that there may be more devices that match the
241
- # request; this value should be passed in a new `ListDevicesRequest`.
242
- class ListDevicesResponse
243
- include ::Google::Protobuf::MessageExts
244
- extend ::Google::Protobuf::MessageExts::ClassMethods
245
- end
246
-
247
- # Request for `ModifyCloudToDeviceConfig`.
248
- # @!attribute [rw] name
249
- # @return [::String]
250
- # Required. The name of the device. For example,
251
- # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
252
- # `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
253
- # @!attribute [rw] version_to_update
254
- # @return [::Integer]
255
- # The version number to update. If this value is zero, it will not check the
256
- # version number of the server and will always update the current version;
257
- # otherwise, this update will fail if the version number found on the server
258
- # does not match this version number. This is used to support multiple
259
- # simultaneous updates without losing data.
260
- # @!attribute [rw] binary_data
261
- # @return [::String]
262
- # Required. The configuration data for the device.
263
- class ModifyCloudToDeviceConfigRequest
264
- include ::Google::Protobuf::MessageExts
265
- extend ::Google::Protobuf::MessageExts::ClassMethods
266
- end
267
-
268
- # Request for `ListDeviceConfigVersions`.
269
- # @!attribute [rw] name
270
- # @return [::String]
271
- # Required. The name of the device. For example,
272
- # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
273
- # `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
274
- # @!attribute [rw] num_versions
275
- # @return [::Integer]
276
- # The number of versions to list. Versions are listed in decreasing order of
277
- # the version number. The maximum number of versions retained is 10. If this
278
- # value is zero, it will return all the versions available.
279
- class ListDeviceConfigVersionsRequest
280
- include ::Google::Protobuf::MessageExts
281
- extend ::Google::Protobuf::MessageExts::ClassMethods
282
- end
283
-
284
- # Response for `ListDeviceConfigVersions`.
285
- # @!attribute [rw] device_configs
286
- # @return [::Array<::Google::Cloud::Iot::V1::DeviceConfig>]
287
- # The device configuration for the last few versions. Versions are listed
288
- # in decreasing order, starting from the most recent one.
289
- class ListDeviceConfigVersionsResponse
290
- include ::Google::Protobuf::MessageExts
291
- extend ::Google::Protobuf::MessageExts::ClassMethods
292
- end
293
-
294
- # Request for `ListDeviceStates`.
295
- # @!attribute [rw] name
296
- # @return [::String]
297
- # Required. The name of the device. For example,
298
- # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
299
- # `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
300
- # @!attribute [rw] num_states
301
- # @return [::Integer]
302
- # The number of states to list. States are listed in descending order of
303
- # update time. The maximum number of states retained is 10. If this
304
- # value is zero, it will return all the states available.
305
- class ListDeviceStatesRequest
306
- include ::Google::Protobuf::MessageExts
307
- extend ::Google::Protobuf::MessageExts::ClassMethods
308
- end
309
-
310
- # Response for `ListDeviceStates`.
311
- # @!attribute [rw] device_states
312
- # @return [::Array<::Google::Cloud::Iot::V1::DeviceState>]
313
- # The last few device states. States are listed in descending order of server
314
- # update time, starting from the most recent one.
315
- class ListDeviceStatesResponse
316
- include ::Google::Protobuf::MessageExts
317
- extend ::Google::Protobuf::MessageExts::ClassMethods
318
- end
319
-
320
- # Request for `SendCommandToDevice`.
321
- # @!attribute [rw] name
322
- # @return [::String]
323
- # Required. The name of the device. For example,
324
- # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
325
- # `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
326
- # @!attribute [rw] binary_data
327
- # @return [::String]
328
- # Required. The command data to send to the device.
329
- # @!attribute [rw] subfolder
330
- # @return [::String]
331
- # Optional subfolder for the command. If empty, the command will be delivered
332
- # to the /devices/\\{device-id}/commands topic, otherwise it will be delivered
333
- # to the /devices/\\{device-id}/commands/\\{subfolder} topic. Multi-level
334
- # subfolders are allowed. This field must not have more than 256 characters,
335
- # and must not contain any MQTT wildcards ("+" or "#") or null characters.
336
- class SendCommandToDeviceRequest
337
- include ::Google::Protobuf::MessageExts
338
- extend ::Google::Protobuf::MessageExts::ClassMethods
339
- end
340
-
341
- # Response for `SendCommandToDevice`.
342
- class SendCommandToDeviceResponse
343
- include ::Google::Protobuf::MessageExts
344
- extend ::Google::Protobuf::MessageExts::ClassMethods
345
- end
346
-
347
- # Request for `BindDeviceToGateway`.
348
- # @!attribute [rw] parent
349
- # @return [::String]
350
- # Required. The name of the registry. For example,
351
- # `projects/example-project/locations/us-central1/registries/my-registry`.
352
- # @!attribute [rw] gateway_id
353
- # @return [::String]
354
- # Required. The value of `gateway_id` can be either the device numeric ID or the
355
- # user-defined device identifier.
356
- # @!attribute [rw] device_id
357
- # @return [::String]
358
- # Required. The device to associate with the specified gateway. The value of
359
- # `device_id` can be either the device numeric ID or the user-defined device
360
- # identifier.
361
- class BindDeviceToGatewayRequest
362
- include ::Google::Protobuf::MessageExts
363
- extend ::Google::Protobuf::MessageExts::ClassMethods
364
- end
365
-
366
- # Response for `BindDeviceToGateway`.
367
- class BindDeviceToGatewayResponse
368
- include ::Google::Protobuf::MessageExts
369
- extend ::Google::Protobuf::MessageExts::ClassMethods
370
- end
371
-
372
- # Request for `UnbindDeviceFromGateway`.
373
- # @!attribute [rw] parent
374
- # @return [::String]
375
- # Required. The name of the registry. For example,
376
- # `projects/example-project/locations/us-central1/registries/my-registry`.
377
- # @!attribute [rw] gateway_id
378
- # @return [::String]
379
- # Required. The value of `gateway_id` can be either the device numeric ID or the
380
- # user-defined device identifier.
381
- # @!attribute [rw] device_id
382
- # @return [::String]
383
- # Required. The device to disassociate from the specified gateway. The value of
384
- # `device_id` can be either the device numeric ID or the user-defined device
385
- # identifier.
386
- class UnbindDeviceFromGatewayRequest
387
- include ::Google::Protobuf::MessageExts
388
- extend ::Google::Protobuf::MessageExts::ClassMethods
389
- end
390
-
391
- # Response for `UnbindDeviceFromGateway`.
392
- class UnbindDeviceFromGatewayResponse
393
- include ::Google::Protobuf::MessageExts
394
- extend ::Google::Protobuf::MessageExts::ClassMethods
395
- end
396
- end
397
- end
398
- end
399
- end