google-cloud-device_streaming-v1 0.1.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 (31) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +153 -0
  6. data/lib/google/cloud/device_streaming/v1/direct_access_service/client.rb +978 -0
  7. data/lib/google/cloud/device_streaming/v1/direct_access_service/credentials.rb +47 -0
  8. data/lib/google/cloud/device_streaming/v1/direct_access_service/paths.rb +64 -0
  9. data/lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb +827 -0
  10. data/lib/google/cloud/device_streaming/v1/direct_access_service/rest/service_stub.rb +389 -0
  11. data/lib/google/cloud/device_streaming/v1/direct_access_service/rest.rb +61 -0
  12. data/lib/google/cloud/device_streaming/v1/direct_access_service.rb +64 -0
  13. data/lib/google/cloud/device_streaming/v1/rest.rb +37 -0
  14. data/lib/google/cloud/device_streaming/v1/version.rb +28 -0
  15. data/lib/google/cloud/device_streaming/v1.rb +45 -0
  16. data/lib/google/cloud/devicestreaming/v1/adb_service_pb.rb +53 -0
  17. data/lib/google/cloud/devicestreaming/v1/service_pb.rb +64 -0
  18. data/lib/google/cloud/devicestreaming/v1/service_services_pb.rb +74 -0
  19. data/lib/google-cloud-device_streaming-v1.rb +21 -0
  20. data/proto_docs/README.md +4 -0
  21. data/proto_docs/google/api/client.rb +473 -0
  22. data/proto_docs/google/api/field_behavior.rb +85 -0
  23. data/proto_docs/google/api/launch_stage.rb +71 -0
  24. data/proto_docs/google/api/resource.rb +227 -0
  25. data/proto_docs/google/cloud/devicestreaming/v1/adb_service.rb +192 -0
  26. data/proto_docs/google/cloud/devicestreaming/v1/service.rb +234 -0
  27. data/proto_docs/google/protobuf/duration.rb +98 -0
  28. data/proto_docs/google/protobuf/empty.rb +34 -0
  29. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  30. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  31. metadata +99 -0
@@ -0,0 +1,227 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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'. One exception
128
+ # to this is for Nested Collections that have stuttering names, as defined
129
+ # in [AIP-122](https://google.aip.dev/122#nested-collections), where the
130
+ # collection ID in the resource name pattern does not necessarily directly
131
+ # match the `plural` value.
132
+ #
133
+ # It is the same concept of the `plural` field in k8s CRD spec
134
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
135
+ #
136
+ # Note: The plural form is required even for singleton resources. See
137
+ # https://aip.dev/156
138
+ # @!attribute [rw] singular
139
+ # @return [::String]
140
+ # The same concept of the `singular` field in k8s CRD spec
141
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
142
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
143
+ # @!attribute [rw] style
144
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
145
+ # Style flag(s) for this resource.
146
+ # These indicate that a resource is expected to conform to a given
147
+ # style. See the specific style flags for additional information.
148
+ class ResourceDescriptor
149
+ include ::Google::Protobuf::MessageExts
150
+ extend ::Google::Protobuf::MessageExts::ClassMethods
151
+
152
+ # A description of the historical or future-looking state of the
153
+ # resource pattern.
154
+ module History
155
+ # The "unset" value.
156
+ HISTORY_UNSPECIFIED = 0
157
+
158
+ # The resource originally had one pattern and launched as such, and
159
+ # additional patterns were added later.
160
+ ORIGINALLY_SINGLE_PATTERN = 1
161
+
162
+ # The resource has one pattern, but the API owner expects to add more
163
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
164
+ # that from being necessary once there are multiple patterns.)
165
+ FUTURE_MULTI_PATTERN = 2
166
+ end
167
+
168
+ # A flag representing a specific style that a resource claims to conform to.
169
+ module Style
170
+ # The unspecified value. Do not use.
171
+ STYLE_UNSPECIFIED = 0
172
+
173
+ # This resource is intended to be "declarative-friendly".
174
+ #
175
+ # Declarative-friendly resources must be more strictly consistent, and
176
+ # setting this to true communicates to tools that this resource should
177
+ # adhere to declarative-friendly expectations.
178
+ #
179
+ # Note: This is used by the API linter (linter.aip.dev) to enable
180
+ # additional checks.
181
+ DECLARATIVE_FRIENDLY = 1
182
+ end
183
+ end
184
+
185
+ # Defines a proto annotation that describes a string field that refers to
186
+ # an API resource.
187
+ # @!attribute [rw] type
188
+ # @return [::String]
189
+ # The resource type that the annotated field references.
190
+ #
191
+ # Example:
192
+ #
193
+ # message Subscription {
194
+ # string topic = 2 [(google.api.resource_reference) = {
195
+ # type: "pubsub.googleapis.com/Topic"
196
+ # }];
197
+ # }
198
+ #
199
+ # Occasionally, a field may reference an arbitrary resource. In this case,
200
+ # APIs use the special value * in their resource reference.
201
+ #
202
+ # Example:
203
+ #
204
+ # message GetIamPolicyRequest {
205
+ # string resource = 2 [(google.api.resource_reference) = {
206
+ # type: "*"
207
+ # }];
208
+ # }
209
+ # @!attribute [rw] child_type
210
+ # @return [::String]
211
+ # The resource type of a child collection that the annotated field
212
+ # references. This is useful for annotating the `parent` field that
213
+ # doesn't have a fixed resource type.
214
+ #
215
+ # Example:
216
+ #
217
+ # message ListLogEntriesRequest {
218
+ # string parent = 1 [(google.api.resource_reference) = {
219
+ # child_type: "logging.googleapis.com/LogEntry"
220
+ # };
221
+ # }
222
+ class ResourceReference
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
+ end
226
+ end
227
+ end
@@ -0,0 +1,192 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 DeviceStreaming
23
+ module V1
24
+ # A message returned from a device.
25
+ # @!attribute [rw] status_update
26
+ # @return [::Google::Cloud::DeviceStreaming::V1::StatusUpdate]
27
+ # Information about the device's state.
28
+ #
29
+ # Note: The following fields are mutually exclusive: `status_update`, `stream_status`, `stream_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
30
+ # @!attribute [rw] stream_status
31
+ # @return [::Google::Cloud::DeviceStreaming::V1::StreamStatus]
32
+ # The result of a device stream from ADB.
33
+ #
34
+ # Note: The following fields are mutually exclusive: `stream_status`, `status_update`, `stream_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
35
+ # @!attribute [rw] stream_data
36
+ # @return [::Google::Cloud::DeviceStreaming::V1::StreamData]
37
+ # Data from an open stream.
38
+ #
39
+ # Note: The following fields are mutually exclusive: `stream_data`, `status_update`, `stream_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
40
+ class DeviceMessage
41
+ include ::Google::Protobuf::MessageExts
42
+ extend ::Google::Protobuf::MessageExts::ClassMethods
43
+ end
44
+
45
+ # A message to an ADB server.
46
+ # @!attribute [rw] open
47
+ # @return [::Google::Cloud::DeviceStreaming::V1::Open]
48
+ # Open a new stream.
49
+ #
50
+ # Note: The following fields are mutually exclusive: `open`, `stream_data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
51
+ # @!attribute [rw] stream_data
52
+ # @return [::Google::Cloud::DeviceStreaming::V1::StreamData]
53
+ # Send data to a stream.
54
+ #
55
+ # Note: The following fields are mutually exclusive: `stream_data`, `open`. If a field in that set is populated, all other fields in the set will automatically be cleared.
56
+ class AdbMessage
57
+ include ::Google::Protobuf::MessageExts
58
+ extend ::Google::Protobuf::MessageExts::ClassMethods
59
+ end
60
+
61
+ # A StatusUpdate message given over the ADB protocol for the device state.
62
+ # @!attribute [rw] state
63
+ # @return [::Google::Cloud::DeviceStreaming::V1::StatusUpdate::DeviceState]
64
+ # The device's state
65
+ # @!attribute [rw] properties
66
+ # @return [::Google::Protobuf::Map{::String => ::String}]
67
+ # A map of properties with information about this device.
68
+ # @!attribute [rw] features
69
+ # @return [::String]
70
+ # A comma-separated list of "features" that this device supports.
71
+ class StatusUpdate
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+
75
+ # @!attribute [rw] key
76
+ # @return [::String]
77
+ # @!attribute [rw] value
78
+ # @return [::String]
79
+ class PropertiesEntry
80
+ include ::Google::Protobuf::MessageExts
81
+ extend ::Google::Protobuf::MessageExts::ClassMethods
82
+ end
83
+
84
+ # The state displayed with the ADB Device when running "adb devices"
85
+ module DeviceState
86
+ # The device state is unknown.
87
+ DEVICE_STATE_UNSPECIFIED = 0
88
+
89
+ # The ADB device is in the "device" status.
90
+ DEVICE = 1
91
+
92
+ # The ADB device is in the "recovery" status.
93
+ RECOVERY = 2
94
+
95
+ # The ADB device is in the "rescue" status.
96
+ RESCUE = 3
97
+
98
+ # The ADB device is in the "sideload" status.
99
+ SIDELOAD = 4
100
+
101
+ # The ADB device is in the "missing" status.
102
+ MISSING = 10
103
+
104
+ # The ADB device is in the "offline" status.
105
+ OFFLINE = 11
106
+
107
+ # The ADB device is in the "unauthorized" status.
108
+ UNAUTHORIZED = 12
109
+
110
+ # The ADB device is in the "authorizing" status.
111
+ AUTHORIZING = 13
112
+
113
+ # The ADB device is in the "connecting" status.
114
+ CONNECTING = 14
115
+ end
116
+ end
117
+
118
+ # The result of a stream.
119
+ # @!attribute [rw] stream_id
120
+ # @return [::Integer]
121
+ # The unique ID of this stream, assigned by the client.
122
+ # @!attribute [rw] okay
123
+ # @return [::Google::Cloud::DeviceStreaming::V1::Okay]
124
+ # Okay for success.
125
+ #
126
+ # Note: The following fields are mutually exclusive: `okay`, `fail`. If a field in that set is populated, all other fields in the set will automatically be cleared.
127
+ # @!attribute [rw] fail
128
+ # @return [::Google::Cloud::DeviceStreaming::V1::Fail]
129
+ # Fail for failure.
130
+ #
131
+ # Note: The following fields are mutually exclusive: `fail`, `okay`. If a field in that set is populated, all other fields in the set will automatically be cleared.
132
+ class StreamStatus
133
+ include ::Google::Protobuf::MessageExts
134
+ extend ::Google::Protobuf::MessageExts::ClassMethods
135
+ end
136
+
137
+ # Message for opening a new stream.
138
+ # @!attribute [rw] stream_id
139
+ # @return [::Integer]
140
+ # Required. The unique ID that will be used to talk to this stream. This
141
+ # should probably just be a number that increments for each new Open request.
142
+ # @!attribute [rw] service
143
+ # @return [::String]
144
+ # Optional. An ADB service to use in the new stream.
145
+ class Open
146
+ include ::Google::Protobuf::MessageExts
147
+ extend ::Google::Protobuf::MessageExts::ClassMethods
148
+ end
149
+
150
+ # Data for a stream.
151
+ # @!attribute [rw] stream_id
152
+ # @return [::Integer]
153
+ # Required. The unique ID of this stream, assigned by the client.
154
+ # @!attribute [rw] data
155
+ # @return [::String]
156
+ # Data in the stream.
157
+ #
158
+ # Note: The following fields are mutually exclusive: `data`, `close`. If a field in that set is populated, all other fields in the set will automatically be cleared.
159
+ # @!attribute [rw] close
160
+ # @return [::Google::Cloud::DeviceStreaming::V1::Close]
161
+ # The stream is closing. EOF.
162
+ #
163
+ # Note: The following fields are mutually exclusive: `close`, `data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
164
+ class StreamData
165
+ include ::Google::Protobuf::MessageExts
166
+ extend ::Google::Protobuf::MessageExts::ClassMethods
167
+ end
168
+
169
+ # Message signifying that the stream is open
170
+ class Okay
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Message signifying that the stream failed to open
176
+ # @!attribute [rw] reason
177
+ # @return [::String]
178
+ # A user-displayable failure reason.
179
+ class Fail
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Message signifying that the stream closed.
185
+ class Close
186
+ include ::Google::Protobuf::MessageExts
187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
188
+ end
189
+ end
190
+ end
191
+ end
192
+ end
@@ -0,0 +1,234 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 DeviceStreaming
23
+ module V1
24
+ # Request message for DirectAccessService.CreateDeviceSession.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The Compute Engine project under which this device will be
28
+ # allocated. "projects/\\{project_id}"
29
+ # @!attribute [rw] device_session
30
+ # @return [::Google::Cloud::DeviceStreaming::V1::DeviceSession]
31
+ # Required. A DeviceSession to create.
32
+ # @!attribute [rw] device_session_id
33
+ # @return [::String]
34
+ # Optional. The ID to use for the DeviceSession, which will become the final
35
+ # component of the DeviceSession's resource name.
36
+ #
37
+ # This value should be 4-63 characters, and valid characters
38
+ # are /[a-z][0-9]-/.
39
+ class CreateDeviceSessionRequest
40
+ include ::Google::Protobuf::MessageExts
41
+ extend ::Google::Protobuf::MessageExts::ClassMethods
42
+ end
43
+
44
+ # Request message for DirectAccessService.ListDeviceSessions.
45
+ # @!attribute [rw] parent
46
+ # @return [::String]
47
+ # Required. The name of the parent to request, e.g. "projects/\\{project_id}"
48
+ # @!attribute [rw] page_size
49
+ # @return [::Integer]
50
+ # Optional. The maximum number of DeviceSessions to return.
51
+ # @!attribute [rw] page_token
52
+ # @return [::String]
53
+ # Optional. A continuation token for paging.
54
+ # @!attribute [rw] filter
55
+ # @return [::String]
56
+ # Optional. If specified, responses will be filtered by the given filter.
57
+ # Allowed fields are: session_state.
58
+ class ListDeviceSessionsRequest
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
+ end
62
+
63
+ # Response message for DirectAccessService.ListDeviceSessions.
64
+ # @!attribute [rw] device_sessions
65
+ # @return [::Array<::Google::Cloud::DeviceStreaming::V1::DeviceSession>]
66
+ # The sessions matching the specified filter in the given cloud project.
67
+ # @!attribute [rw] next_page_token
68
+ # @return [::String]
69
+ # A token, which can be sent as `page_token` to retrieve the next page.
70
+ # If this field is omitted, there are no subsequent pages.
71
+ class ListDeviceSessionsResponse
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+ end
75
+
76
+ # Request message for DirectAccessService.GetDeviceSession.
77
+ # @!attribute [rw] name
78
+ # @return [::String]
79
+ # Required. Name of the DeviceSession, e.g.
80
+ # "projects/\\{project_id}/deviceSessions/\\{session_id}"
81
+ class GetDeviceSessionRequest
82
+ include ::Google::Protobuf::MessageExts
83
+ extend ::Google::Protobuf::MessageExts::ClassMethods
84
+ end
85
+
86
+ # Request message for DirectAccessService.CancelDeviceSession.
87
+ # @!attribute [rw] name
88
+ # @return [::String]
89
+ # Required. Name of the DeviceSession, e.g.
90
+ # "projects/\\{project_id}/deviceSessions/\\{session_id}"
91
+ class CancelDeviceSessionRequest
92
+ include ::Google::Protobuf::MessageExts
93
+ extend ::Google::Protobuf::MessageExts::ClassMethods
94
+ end
95
+
96
+ # Request message for DirectAccessService.UpdateDeviceSession.
97
+ # @!attribute [rw] device_session
98
+ # @return [::Google::Cloud::DeviceStreaming::V1::DeviceSession]
99
+ # Required. DeviceSession to update.
100
+ # The DeviceSession's `name` field is used to identify the session to update
101
+ # "projects/\\{project_id}/deviceSessions/\\{session_id}"
102
+ # @!attribute [rw] update_mask
103
+ # @return [::Google::Protobuf::FieldMask]
104
+ # Optional. The list of fields to update.
105
+ class UpdateDeviceSessionRequest
106
+ include ::Google::Protobuf::MessageExts
107
+ extend ::Google::Protobuf::MessageExts::ClassMethods
108
+ end
109
+
110
+ # Protobuf message describing the device message, used from several RPCs.
111
+ # @!attribute [rw] name
112
+ # @return [::String]
113
+ # Optional. Name of the DeviceSession, e.g.
114
+ # "projects/\\{project_id}/deviceSessions/\\{session_id}"
115
+ # @!attribute [r] display_name
116
+ # @return [::String]
117
+ # Output only. The title of the DeviceSession to be presented in the UI.
118
+ # @!attribute [r] state
119
+ # @return [::Google::Cloud::DeviceStreaming::V1::DeviceSession::SessionState]
120
+ # Output only. Current state of the DeviceSession.
121
+ # @!attribute [r] state_histories
122
+ # @return [::Array<::Google::Cloud::DeviceStreaming::V1::DeviceSession::SessionStateEvent>]
123
+ # Output only. The historical state transitions of the session_state message
124
+ # including the current session state.
125
+ # @!attribute [rw] ttl
126
+ # @return [::Google::Protobuf::Duration]
127
+ # Optional. The amount of time that a device will be initially allocated
128
+ # for. This can eventually be extended with the UpdateDeviceSession RPC.
129
+ # Default: 15 minutes.
130
+ #
131
+ # Note: The following fields are mutually exclusive: `ttl`, `expire_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
132
+ # @!attribute [rw] expire_time
133
+ # @return [::Google::Protobuf::Timestamp]
134
+ # Optional. If the device is still in use at this time, any connections
135
+ # will be ended and the SessionState will transition from ACTIVE to
136
+ # FINISHED.
137
+ #
138
+ # Note: The following fields are mutually exclusive: `expire_time`, `ttl`. If a field in that set is populated, all other fields in the set will automatically be cleared.
139
+ # @!attribute [r] inactivity_timeout
140
+ # @return [::Google::Protobuf::Duration]
141
+ # Output only. The interval of time that this device must be interacted with
142
+ # before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
143
+ # @!attribute [r] create_time
144
+ # @return [::Google::Protobuf::Timestamp]
145
+ # Output only. The time that the Session was created.
146
+ # @!attribute [r] active_start_time
147
+ # @return [::Google::Protobuf::Timestamp]
148
+ # Output only. The timestamp that the session first became ACTIVE.
149
+ # @!attribute [rw] android_device
150
+ # @return [::Google::Cloud::DeviceStreaming::V1::AndroidDevice]
151
+ # Required. The requested device
152
+ class DeviceSession
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # A message encapsulating a series of Session states and the time that the
157
+ # DeviceSession first entered those states.
158
+ # @!attribute [r] session_state
159
+ # @return [::Google::Cloud::DeviceStreaming::V1::DeviceSession::SessionState]
160
+ # Output only. The session_state tracked by this event
161
+ # @!attribute [r] event_time
162
+ # @return [::Google::Protobuf::Timestamp]
163
+ # Output only. The time that the session_state first encountered that
164
+ # state.
165
+ # @!attribute [r] state_message
166
+ # @return [::String]
167
+ # Output only. A human-readable message to explain the state.
168
+ class SessionStateEvent
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
172
+
173
+ # The state that the DeviceSession resides.
174
+ module SessionState
175
+ # Default value. This value is unused.
176
+ SESSION_STATE_UNSPECIFIED = 0
177
+
178
+ # Initial state of a session request. The session is being validated for
179
+ # correctness and a device is not yet requested.
180
+ REQUESTED = 1
181
+
182
+ # The session has been validated and is in the queue for a device.
183
+ PENDING = 2
184
+
185
+ # The session has been granted and the device is accepting
186
+ # connections.
187
+ ACTIVE = 3
188
+
189
+ # The session duration exceeded the device's reservation time period and
190
+ # timed out automatically.
191
+ EXPIRED = 4
192
+
193
+ # The user is finished with the session and it was canceled by the user
194
+ # while the request was still getting allocated or after allocation and
195
+ # during device usage period.
196
+ FINISHED = 5
197
+
198
+ # Unable to complete the session because the device was unavailable and
199
+ # it failed to allocate through the scheduler. For example, a device not
200
+ # in the catalog was requested or the request expired in the allocation
201
+ # queue.
202
+ UNAVAILABLE = 6
203
+
204
+ # Unable to complete the session for an internal reason, such as an
205
+ # infrastructure failure.
206
+ ERROR = 7
207
+ end
208
+ end
209
+
210
+ # A single Android device.
211
+ # @!attribute [rw] android_model_id
212
+ # @return [::String]
213
+ # Required. The id of the Android device to be used.
214
+ # Use the TestEnvironmentDiscoveryService to get supported options.
215
+ # @!attribute [rw] android_version_id
216
+ # @return [::String]
217
+ # Required. The id of the Android OS version to be used.
218
+ # Use the TestEnvironmentDiscoveryService to get supported options.
219
+ # @!attribute [rw] locale
220
+ # @return [::String]
221
+ # Optional. The locale the test device used for testing.
222
+ # Use the TestEnvironmentDiscoveryService to get supported options.
223
+ # @!attribute [rw] orientation
224
+ # @return [::String]
225
+ # Optional. How the device is oriented during the test.
226
+ # Use the TestEnvironmentDiscoveryService to get supported options.
227
+ class AndroidDevice
228
+ include ::Google::Protobuf::MessageExts
229
+ extend ::Google::Protobuf::MessageExts::ClassMethods
230
+ end
231
+ end
232
+ end
233
+ end
234
+ end