google-apis-devicerun_v1alpha 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.
@@ -0,0 +1,681 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module DevicerunV1alpha
23
+ # Device Run API
24
+ #
25
+ # The Device Run API allows management, scheduling, and execution of automated
26
+ # sessions and workloads across device catalogs.
27
+ #
28
+ # @example
29
+ # require 'google/apis/devicerun_v1alpha'
30
+ #
31
+ # Devicerun = Google::Apis::DevicerunV1alpha # Alias the module
32
+ # service = Devicerun::DeviceRunService.new
33
+ #
34
+ # @see https://docs.cloud.google.com/developer-device-platform/device-run
35
+ class DeviceRunService < Google::Apis::Core::BaseService
36
+ DEFAULT_ENDPOINT_TEMPLATE = "https://devicerun.$UNIVERSE_DOMAIN$/"
37
+
38
+ # @return [String]
39
+ # API key. Your API key identifies your project and provides you with API access,
40
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
41
+ attr_accessor :key
42
+
43
+ # @return [String]
44
+ # Available to use for quota purposes for server-side applications. Can be any
45
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
46
+ attr_accessor :quota_user
47
+
48
+ def initialize
49
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
50
+ client_name: 'google-apis-devicerun_v1alpha',
51
+ client_version: Google::Apis::DevicerunV1alpha::GEM_VERSION)
52
+ @batch_path = 'batch'
53
+ end
54
+
55
+ # Gets information about a location.
56
+ # @param [String] name
57
+ # Resource name for the location.
58
+ # @param [String] fields
59
+ # Selector specifying which fields to include in a partial response.
60
+ # @param [String] quota_user
61
+ # Available to use for quota purposes for server-side applications. Can be any
62
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
63
+ # @param [Google::Apis::RequestOptions] options
64
+ # Request-specific options
65
+ #
66
+ # @yield [result, err] Result & error if block supplied
67
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::Location] parsed result object
68
+ # @yieldparam err [StandardError] error object if request failed
69
+ #
70
+ # @return [Google::Apis::DevicerunV1alpha::Location]
71
+ #
72
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
73
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
74
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
75
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
76
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
77
+ command.response_representation = Google::Apis::DevicerunV1alpha::Location::Representation
78
+ command.response_class = Google::Apis::DevicerunV1alpha::Location
79
+ command.params['name'] = name unless name.nil?
80
+ command.query['fields'] = fields unless fields.nil?
81
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
82
+ execute_or_queue_command(command, &block)
83
+ end
84
+
85
+ # Lists information about the supported locations for this service. This method
86
+ # lists locations based on the resource scope provided in the
87
+ # ListLocationsRequest.name field: * **Global locations**: If `name` is empty,
88
+ # the method lists the public locations available to all projects. * **Project-
89
+ # specific locations**: If `name` follows the format `projects/`project``, the
90
+ # method lists locations visible to that specific project. This includes public,
91
+ # private, or other project-specific locations enabled for the project. For gRPC
92
+ # and client library implementations, the resource name is passed as the `name`
93
+ # field. For direct service calls, the resource name is incorporated into the
94
+ # request path based on the specific service implementation and version.
95
+ # @param [String] name
96
+ # The resource that owns the locations collection, if applicable.
97
+ # @param [Array<String>, String] extra_location_types
98
+ # Optional. Do not use this field unless explicitly documented otherwise. This
99
+ # is primarily for internal usage.
100
+ # @param [String] filter
101
+ # A filter to narrow down results to a preferred subset. The filtering language
102
+ # accepts strings like `"displayName=tokyo"`, and is documented in more detail
103
+ # in [AIP-160](https://google.aip.dev/160).
104
+ # @param [Fixnum] page_size
105
+ # The maximum number of results to return. If not set, the service selects a
106
+ # default.
107
+ # @param [String] page_token
108
+ # A page token received from the `next_page_token` field in the response. Send
109
+ # that page token to receive the subsequent page.
110
+ # @param [String] fields
111
+ # Selector specifying which fields to include in a partial response.
112
+ # @param [String] quota_user
113
+ # Available to use for quota purposes for server-side applications. Can be any
114
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
115
+ # @param [Google::Apis::RequestOptions] options
116
+ # Request-specific options
117
+ #
118
+ # @yield [result, err] Result & error if block supplied
119
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::ListLocationsResponse] parsed result object
120
+ # @yieldparam err [StandardError] error object if request failed
121
+ #
122
+ # @return [Google::Apis::DevicerunV1alpha::ListLocationsResponse]
123
+ #
124
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
125
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
126
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
127
+ def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
128
+ command = make_simple_command(:get, 'v1alpha/{+name}/locations', options)
129
+ command.response_representation = Google::Apis::DevicerunV1alpha::ListLocationsResponse::Representation
130
+ command.response_class = Google::Apis::DevicerunV1alpha::ListLocationsResponse
131
+ command.params['name'] = name unless name.nil?
132
+ command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
133
+ command.query['filter'] = filter unless filter.nil?
134
+ command.query['pageSize'] = page_size unless page_size.nil?
135
+ command.query['pageToken'] = page_token unless page_token.nil?
136
+ command.query['fields'] = fields unless fields.nil?
137
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
138
+ execute_or_queue_command(command, &block)
139
+ end
140
+
141
+ # Returns information about a specific device.
142
+ # @param [String] name
143
+ # Required. The name of the device. Format: `projects/`project`/locations/global/
144
+ # devices/`device``.
145
+ # @param [String] fields
146
+ # Selector specifying which fields to include in a partial response.
147
+ # @param [String] quota_user
148
+ # Available to use for quota purposes for server-side applications. Can be any
149
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
150
+ # @param [Google::Apis::RequestOptions] options
151
+ # Request-specific options
152
+ #
153
+ # @yield [result, err] Result & error if block supplied
154
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::CatalogDevice] parsed result object
155
+ # @yieldparam err [StandardError] error object if request failed
156
+ #
157
+ # @return [Google::Apis::DevicerunV1alpha::CatalogDevice]
158
+ #
159
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
160
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
161
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
162
+ def get_project_location_device(name, fields: nil, quota_user: nil, options: nil, &block)
163
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
164
+ command.response_representation = Google::Apis::DevicerunV1alpha::CatalogDevice::Representation
165
+ command.response_class = Google::Apis::DevicerunV1alpha::CatalogDevice
166
+ command.params['name'] = name unless name.nil?
167
+ command.query['fields'] = fields unless fields.nil?
168
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
169
+ execute_or_queue_command(command, &block)
170
+ end
171
+
172
+ # Lists all devices.
173
+ # @param [String] parent
174
+ # Required. The parent of the collection of devices. Format: `projects/`project`/
175
+ # locations/global`.
176
+ # @param [String] filter
177
+ # Optional. An AIP-160 (https://google.aip.dev/160) filter expression
178
+ # restricting which devices are returned. An empty filter returns all devices.
179
+ # Filtering is supported over the `Device` fields, including nested fields via
180
+ # dot-path. Enum and string values must be double-quoted. Examples: * `platform =
181
+ # "ANDROID"` * `platform = "ANDROID" AND os_version = "34"` * `hardware_type = "
182
+ # PHYSICAL" AND form_factor = "PHONE"` * `android_details.build_type = "
183
+ # userdebug"` * `availability.capacity = "HIGH"`
184
+ # @param [Fixnum] page_size
185
+ # Optional. The maximum number of devices to return. The server may return fewer
186
+ # items than this value.
187
+ # @param [String] page_token
188
+ # Optional. A page token, received from a previous `ListDevices` call. Provide
189
+ # this to receive the subsequent page. When paginating, all other parameters
190
+ # provided to `ListDevices` must match the call that provided the page token.
191
+ # @param [String] fields
192
+ # Selector specifying which fields to include in a partial response.
193
+ # @param [String] quota_user
194
+ # Available to use for quota purposes for server-side applications. Can be any
195
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
196
+ # @param [Google::Apis::RequestOptions] options
197
+ # Request-specific options
198
+ #
199
+ # @yield [result, err] Result & error if block supplied
200
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::CatalogListDevicesResponse] parsed result object
201
+ # @yieldparam err [StandardError] error object if request failed
202
+ #
203
+ # @return [Google::Apis::DevicerunV1alpha::CatalogListDevicesResponse]
204
+ #
205
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
206
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
207
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
208
+ def list_project_location_devices(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
209
+ command = make_simple_command(:get, 'v1alpha/{+parent}/devices', options)
210
+ command.response_representation = Google::Apis::DevicerunV1alpha::CatalogListDevicesResponse::Representation
211
+ command.response_class = Google::Apis::DevicerunV1alpha::CatalogListDevicesResponse
212
+ command.params['parent'] = parent unless parent.nil?
213
+ command.query['filter'] = filter unless filter.nil?
214
+ command.query['pageSize'] = page_size unless page_size.nil?
215
+ command.query['pageToken'] = page_token unless page_token.nil?
216
+ command.query['fields'] = fields unless fields.nil?
217
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
218
+ execute_or_queue_command(command, &block)
219
+ end
220
+
221
+ # Starts asynchronous cancellation on a long-running operation. The server makes
222
+ # a best effort to cancel the operation, but success is not guaranteed. If the
223
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
224
+ # Clients can use Operations.GetOperation or other methods to check whether the
225
+ # cancellation succeeded or whether the operation completed despite cancellation.
226
+ # On successful cancellation, the operation is not deleted; instead, it becomes
227
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
228
+ # , corresponding to `Code.CANCELLED`.
229
+ # @param [String] name
230
+ # The name of the operation resource to be cancelled.
231
+ # @param [Google::Apis::DevicerunV1alpha::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
232
+ # @param [String] fields
233
+ # Selector specifying which fields to include in a partial response.
234
+ # @param [String] quota_user
235
+ # Available to use for quota purposes for server-side applications. Can be any
236
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
237
+ # @param [Google::Apis::RequestOptions] options
238
+ # Request-specific options
239
+ #
240
+ # @yield [result, err] Result & error if block supplied
241
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::Empty] parsed result object
242
+ # @yieldparam err [StandardError] error object if request failed
243
+ #
244
+ # @return [Google::Apis::DevicerunV1alpha::Empty]
245
+ #
246
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
247
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
248
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
249
+ def cancel_project_location_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
250
+ command = make_simple_command(:post, 'v1alpha/{+name}:cancel', options)
251
+ command.request_representation = Google::Apis::DevicerunV1alpha::GoogleLongrunningCancelOperationRequest::Representation
252
+ command.request_object = google_longrunning_cancel_operation_request_object
253
+ command.response_representation = Google::Apis::DevicerunV1alpha::Empty::Representation
254
+ command.response_class = Google::Apis::DevicerunV1alpha::Empty
255
+ command.params['name'] = name unless name.nil?
256
+ command.query['fields'] = fields unless fields.nil?
257
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
258
+ execute_or_queue_command(command, &block)
259
+ end
260
+
261
+ # Deletes a long-running operation. This method indicates that the client is no
262
+ # longer interested in the operation result. It does not cancel the operation.
263
+ # If the server doesn't support this method, it returns `google.rpc.Code.
264
+ # UNIMPLEMENTED`.
265
+ # @param [String] name
266
+ # The name of the operation resource to be deleted.
267
+ # @param [String] fields
268
+ # Selector specifying which fields to include in a partial response.
269
+ # @param [String] quota_user
270
+ # Available to use for quota purposes for server-side applications. Can be any
271
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
272
+ # @param [Google::Apis::RequestOptions] options
273
+ # Request-specific options
274
+ #
275
+ # @yield [result, err] Result & error if block supplied
276
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::Empty] parsed result object
277
+ # @yieldparam err [StandardError] error object if request failed
278
+ #
279
+ # @return [Google::Apis::DevicerunV1alpha::Empty]
280
+ #
281
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
282
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
283
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
284
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
285
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
286
+ command.response_representation = Google::Apis::DevicerunV1alpha::Empty::Representation
287
+ command.response_class = Google::Apis::DevicerunV1alpha::Empty
288
+ command.params['name'] = name unless name.nil?
289
+ command.query['fields'] = fields unless fields.nil?
290
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
291
+ execute_or_queue_command(command, &block)
292
+ end
293
+
294
+ # Gets the latest state of a long-running operation. Clients can use this method
295
+ # to poll the operation result at intervals as recommended by the API service.
296
+ # @param [String] name
297
+ # The name of the operation resource.
298
+ # @param [String] fields
299
+ # Selector specifying which fields to include in a partial response.
300
+ # @param [String] quota_user
301
+ # Available to use for quota purposes for server-side applications. Can be any
302
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
303
+ # @param [Google::Apis::RequestOptions] options
304
+ # Request-specific options
305
+ #
306
+ # @yield [result, err] Result & error if block supplied
307
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation] parsed result object
308
+ # @yieldparam err [StandardError] error object if request failed
309
+ #
310
+ # @return [Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation]
311
+ #
312
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
313
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
314
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
315
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
316
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
317
+ command.response_representation = Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation::Representation
318
+ command.response_class = Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation
319
+ command.params['name'] = name unless name.nil?
320
+ command.query['fields'] = fields unless fields.nil?
321
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
322
+ execute_or_queue_command(command, &block)
323
+ end
324
+
325
+ # Lists operations that match the specified filter in the request. If the server
326
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
327
+ # @param [String] name
328
+ # The name of the operation's parent resource.
329
+ # @param [String] filter
330
+ # The standard list filter.
331
+ # @param [Fixnum] page_size
332
+ # The standard list page size.
333
+ # @param [String] page_token
334
+ # The standard list page token.
335
+ # @param [Boolean] return_partial_success
336
+ # When set to `true`, operations that are reachable are returned as normal, and
337
+ # those that are unreachable are returned in the ListOperationsResponse.
338
+ # unreachable field. This can only be `true` when reading across collections.
339
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
340
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
341
+ # if set unless explicitly documented otherwise in service or product specific
342
+ # documentation.
343
+ # @param [String] fields
344
+ # Selector specifying which fields to include in a partial response.
345
+ # @param [String] quota_user
346
+ # Available to use for quota purposes for server-side applications. Can be any
347
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
348
+ # @param [Google::Apis::RequestOptions] options
349
+ # Request-specific options
350
+ #
351
+ # @yield [result, err] Result & error if block supplied
352
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
353
+ # @yieldparam err [StandardError] error object if request failed
354
+ #
355
+ # @return [Google::Apis::DevicerunV1alpha::GoogleLongrunningListOperationsResponse]
356
+ #
357
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
358
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
359
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
360
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
361
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
362
+ command.response_representation = Google::Apis::DevicerunV1alpha::GoogleLongrunningListOperationsResponse::Representation
363
+ command.response_class = Google::Apis::DevicerunV1alpha::GoogleLongrunningListOperationsResponse
364
+ command.params['name'] = name unless name.nil?
365
+ command.query['filter'] = filter unless filter.nil?
366
+ command.query['pageSize'] = page_size unless page_size.nil?
367
+ command.query['pageToken'] = page_token unless page_token.nil?
368
+ command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
369
+ command.query['fields'] = fields unless fields.nil?
370
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
371
+ execute_or_queue_command(command, &block)
372
+ end
373
+
374
+ # Cancels an in-progress automation session. This RPC returns immediately and
375
+ # cancellation proceeds asynchronously. If the session is already finished, this
376
+ # RPC will have no effect.
377
+ # @param [String] name
378
+ # Required. The name of the session. Format: "projects/`project`/locations/`
379
+ # location`/sessions/`session`"
380
+ # @param [Google::Apis::DevicerunV1alpha::CancelSessionRequest] cancel_session_request_object
381
+ # @param [String] fields
382
+ # Selector specifying which fields to include in a partial response.
383
+ # @param [String] quota_user
384
+ # Available to use for quota purposes for server-side applications. Can be any
385
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
386
+ # @param [Google::Apis::RequestOptions] options
387
+ # Request-specific options
388
+ #
389
+ # @yield [result, err] Result & error if block supplied
390
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::CancelSessionResponse] parsed result object
391
+ # @yieldparam err [StandardError] error object if request failed
392
+ #
393
+ # @return [Google::Apis::DevicerunV1alpha::CancelSessionResponse]
394
+ #
395
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
396
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
397
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
398
+ def cancel_session(name, cancel_session_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
399
+ command = make_simple_command(:post, 'v1alpha/{+name}:cancel', options)
400
+ command.request_representation = Google::Apis::DevicerunV1alpha::CancelSessionRequest::Representation
401
+ command.request_object = cancel_session_request_object
402
+ command.response_representation = Google::Apis::DevicerunV1alpha::CancelSessionResponse::Representation
403
+ command.response_class = Google::Apis::DevicerunV1alpha::CancelSessionResponse
404
+ command.params['name'] = name unless name.nil?
405
+ command.query['fields'] = fields unless fields.nil?
406
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
407
+ execute_or_queue_command(command, &block)
408
+ end
409
+
410
+ # Starts an automation session with the specified configuration. This method
411
+ # returns a long-running `Operation`, awaiting the completion of all jobs in the
412
+ # session.
413
+ # @param [String] parent
414
+ # Required. The parent resource where this session will be created. Format: `
415
+ # projects/`project`/locations/`location``.
416
+ # @param [Google::Apis::DevicerunV1alpha::Session] session_object
417
+ # @param [String] request_id
418
+ # Optional. A unique identifier for this request. This request is only
419
+ # idempotent if a `request_id` is provided, i.e. if a request with the same `
420
+ # request_id` is received, then the previous result will be returned. The server
421
+ # will guarantee that for at least 60 minutes after the first request. The value
422
+ # must be a UUID (e.g., 123e4567-e89b-12d3-a456-426655440000). See github.com/
423
+ # google/uuid for more details.
424
+ # @param [String] session_id
425
+ # Optional. The ID to use for the session, which will become the final component
426
+ # of the resource name. If not provided, the server will generate a value for
427
+ # this field. When provided, this value must be between 4 and 63 characters, and
428
+ # match the following regex: ^a-z`2,61`[a-z0-9]$.
429
+ # @param [String] fields
430
+ # Selector specifying which fields to include in a partial response.
431
+ # @param [String] quota_user
432
+ # Available to use for quota purposes for server-side applications. Can be any
433
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
434
+ # @param [Google::Apis::RequestOptions] options
435
+ # Request-specific options
436
+ #
437
+ # @yield [result, err] Result & error if block supplied
438
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation] parsed result object
439
+ # @yieldparam err [StandardError] error object if request failed
440
+ #
441
+ # @return [Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation]
442
+ #
443
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
444
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
445
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
446
+ def create_project_location_session(parent, session_object = nil, request_id: nil, session_id: nil, fields: nil, quota_user: nil, options: nil, &block)
447
+ command = make_simple_command(:post, 'v1alpha/{+parent}/sessions', options)
448
+ command.request_representation = Google::Apis::DevicerunV1alpha::Session::Representation
449
+ command.request_object = session_object
450
+ command.response_representation = Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation::Representation
451
+ command.response_class = Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation
452
+ command.params['parent'] = parent unless parent.nil?
453
+ command.query['requestId'] = request_id unless request_id.nil?
454
+ command.query['sessionId'] = session_id unless session_id.nil?
455
+ command.query['fields'] = fields unless fields.nil?
456
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
457
+ execute_or_queue_command(command, &block)
458
+ end
459
+
460
+ # Deletes a session. This RPC returns immediately and deletion proceeds
461
+ # asynchronously. It will cancel the session at first if it is still running.
462
+ # @param [String] name
463
+ # Required. The name of the session. Format: `projects/`project`/locations/`
464
+ # location`/sessions/`session``.
465
+ # @param [String] request_id
466
+ # Optional. A unique identifier for this request. This request is only
467
+ # idempotent if a `request_id` is provided, i.e. if a request with the same `
468
+ # request_id` is received, then the previous result will be returned. The server
469
+ # will guarantee that for at least 60 minutes after the first request. The value
470
+ # must be a UUID (e.g., 123e4567-e89b-12d3-a456-426655440000). See github.com/
471
+ # google/uuid for more details.
472
+ # @param [String] fields
473
+ # Selector specifying which fields to include in a partial response.
474
+ # @param [String] quota_user
475
+ # Available to use for quota purposes for server-side applications. Can be any
476
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
477
+ # @param [Google::Apis::RequestOptions] options
478
+ # Request-specific options
479
+ #
480
+ # @yield [result, err] Result & error if block supplied
481
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation] parsed result object
482
+ # @yieldparam err [StandardError] error object if request failed
483
+ #
484
+ # @return [Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation]
485
+ #
486
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
487
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
488
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
489
+ def delete_project_location_session(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
490
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
491
+ command.response_representation = Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation::Representation
492
+ command.response_class = Google::Apis::DevicerunV1alpha::GoogleLongrunningOperation
493
+ command.params['name'] = name unless name.nil?
494
+ command.query['requestId'] = request_id unless request_id.nil?
495
+ command.query['fields'] = fields unless fields.nil?
496
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
497
+ execute_or_queue_command(command, &block)
498
+ end
499
+
500
+ # Returns information about a previously created automation session.
501
+ # @param [String] name
502
+ # Required. The name of the session. Format: `projects/`project`/locations/`
503
+ # location`/sessions/`session``.
504
+ # @param [String] view
505
+ # Optional. The view of the session to return. If not set, the default BASIC
506
+ # view will be returned.
507
+ # @param [String] fields
508
+ # Selector specifying which fields to include in a partial response.
509
+ # @param [String] quota_user
510
+ # Available to use for quota purposes for server-side applications. Can be any
511
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
512
+ # @param [Google::Apis::RequestOptions] options
513
+ # Request-specific options
514
+ #
515
+ # @yield [result, err] Result & error if block supplied
516
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::Session] parsed result object
517
+ # @yieldparam err [StandardError] error object if request failed
518
+ #
519
+ # @return [Google::Apis::DevicerunV1alpha::Session]
520
+ #
521
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
522
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
523
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
524
+ def get_project_location_session(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
525
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
526
+ command.response_representation = Google::Apis::DevicerunV1alpha::Session::Representation
527
+ command.response_class = Google::Apis::DevicerunV1alpha::Session
528
+ command.params['name'] = name unless name.nil?
529
+ command.query['view'] = view unless view.nil?
530
+ command.query['fields'] = fields unless fields.nil?
531
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
532
+ execute_or_queue_command(command, &block)
533
+ end
534
+
535
+ # Lists previously created automation sessions. Sessions may still be in-
536
+ # progress, or may have finished successfully, or unsuccessfully.
537
+ # @param [String] parent
538
+ # Required. Parent value for ListSessionsRequest The parent of the collection of
539
+ # sessions. Format: `projects/`project`/locations/`location``.
540
+ # @param [String] filter
541
+ # Optional. The raw filter text to constrain the results.
542
+ # @param [String] order_by
543
+ # Optional. The order to sort results by. Supported values: `name`, `name desc`,
544
+ # `create_time`, `create_time desc`. Values must use the snake_case field name; `
545
+ # createTime` is not accepted. Ordering by `create_time` is not supported when
546
+ # listing across all locations (`locations/-`). If unspecified, results are
547
+ # returned in an unspecified order.
548
+ # @param [Fixnum] page_size
549
+ # Optional. The maximum number of sessions to return. The server may return
550
+ # fewer items than this value. If unspecified, at most 500 sessions will be
551
+ # returned. The maximum value is 1000, values above will be coerced to 1000.
552
+ # @param [String] page_token
553
+ # Optional. A page token, received from a previous `ListSessions` call. Provide
554
+ # this to receive the subsequent page. When paginating, all other parameters
555
+ # provided to `ListSessions` must match the call that provided the page token.
556
+ # @param [String] view
557
+ # Optional. The view of the sessions to return. If not set, the `BASIC` view
558
+ # will be returned.
559
+ # @param [String] fields
560
+ # Selector specifying which fields to include in a partial response.
561
+ # @param [String] quota_user
562
+ # Available to use for quota purposes for server-side applications. Can be any
563
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
564
+ # @param [Google::Apis::RequestOptions] options
565
+ # Request-specific options
566
+ #
567
+ # @yield [result, err] Result & error if block supplied
568
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::ListSessionsResponse] parsed result object
569
+ # @yieldparam err [StandardError] error object if request failed
570
+ #
571
+ # @return [Google::Apis::DevicerunV1alpha::ListSessionsResponse]
572
+ #
573
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
574
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
575
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
576
+ def list_project_location_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
577
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sessions', options)
578
+ command.response_representation = Google::Apis::DevicerunV1alpha::ListSessionsResponse::Representation
579
+ command.response_class = Google::Apis::DevicerunV1alpha::ListSessionsResponse
580
+ command.params['parent'] = parent unless parent.nil?
581
+ command.query['filter'] = filter unless filter.nil?
582
+ command.query['orderBy'] = order_by unless order_by.nil?
583
+ command.query['pageSize'] = page_size unless page_size.nil?
584
+ command.query['pageToken'] = page_token unless page_token.nil?
585
+ command.query['view'] = view unless view.nil?
586
+ command.query['fields'] = fields unless fields.nil?
587
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
588
+ execute_or_queue_command(command, &block)
589
+ end
590
+
591
+ # Returns information about a specific software version.
592
+ # @param [String] name
593
+ # Required. The name of the software version. Format: `projects/`project`/
594
+ # locations/global/softwareVersions/`software_version``.
595
+ # @param [String] fields
596
+ # Selector specifying which fields to include in a partial response.
597
+ # @param [String] quota_user
598
+ # Available to use for quota purposes for server-side applications. Can be any
599
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
600
+ # @param [Google::Apis::RequestOptions] options
601
+ # Request-specific options
602
+ #
603
+ # @yield [result, err] Result & error if block supplied
604
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::CatalogSoftwareVersion] parsed result object
605
+ # @yieldparam err [StandardError] error object if request failed
606
+ #
607
+ # @return [Google::Apis::DevicerunV1alpha::CatalogSoftwareVersion]
608
+ #
609
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
610
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
611
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
612
+ def get_project_location_software_version(name, fields: nil, quota_user: nil, options: nil, &block)
613
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
614
+ command.response_representation = Google::Apis::DevicerunV1alpha::CatalogSoftwareVersion::Representation
615
+ command.response_class = Google::Apis::DevicerunV1alpha::CatalogSoftwareVersion
616
+ command.params['name'] = name unless name.nil?
617
+ command.query['fields'] = fields unless fields.nil?
618
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
619
+ execute_or_queue_command(command, &block)
620
+ end
621
+
622
+ # Lists all software versions.
623
+ # @param [String] parent
624
+ # Required. The parent of the collection of software versions. Format: `projects/
625
+ # `project`/locations/global`.
626
+ # @param [String] filter
627
+ # Optional. An AIP-160 (https://google.aip.dev/160) filter expression
628
+ # restricting which software versions are returned. An empty filter returns all
629
+ # software versions. Filtering is supported over the `SoftwareVersion` fields,
630
+ # including nested fields via dot-path. Enum and string values must be double-
631
+ # quoted. Examples: * `software_type = "ANDROIDX_TEST_ORCHESTRATOR"` * `
632
+ # software_type = "ANDROIDX_TEST_ORCHESTRATOR" AND is_default = true` * `
633
+ # lifecycle.state = "ACTIVE"` * `version = "1.4.1"`
634
+ # @param [Fixnum] page_size
635
+ # Optional. The maximum number of software versions to return. The server may
636
+ # return fewer items than this value.
637
+ # @param [String] page_token
638
+ # Optional. A page token, received from a previous `ListSoftwareVersions` call.
639
+ # Provide this to receive the subsequent page. When paginating, all other
640
+ # parameters provided to `ListSoftwareVersions` must match the call that
641
+ # provided the page token.
642
+ # @param [String] fields
643
+ # Selector specifying which fields to include in a partial response.
644
+ # @param [String] quota_user
645
+ # Available to use for quota purposes for server-side applications. Can be any
646
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
647
+ # @param [Google::Apis::RequestOptions] options
648
+ # Request-specific options
649
+ #
650
+ # @yield [result, err] Result & error if block supplied
651
+ # @yieldparam result [Google::Apis::DevicerunV1alpha::CatalogListSoftwareVersionsResponse] parsed result object
652
+ # @yieldparam err [StandardError] error object if request failed
653
+ #
654
+ # @return [Google::Apis::DevicerunV1alpha::CatalogListSoftwareVersionsResponse]
655
+ #
656
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
657
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
658
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
659
+ def list_project_location_software_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
660
+ command = make_simple_command(:get, 'v1alpha/{+parent}/softwareVersions', options)
661
+ command.response_representation = Google::Apis::DevicerunV1alpha::CatalogListSoftwareVersionsResponse::Representation
662
+ command.response_class = Google::Apis::DevicerunV1alpha::CatalogListSoftwareVersionsResponse
663
+ command.params['parent'] = parent unless parent.nil?
664
+ command.query['filter'] = filter unless filter.nil?
665
+ command.query['pageSize'] = page_size unless page_size.nil?
666
+ command.query['pageToken'] = page_token unless page_token.nil?
667
+ command.query['fields'] = fields unless fields.nil?
668
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
669
+ execute_or_queue_command(command, &block)
670
+ end
671
+
672
+ protected
673
+
674
+ def apply_command_defaults(command)
675
+ command.query['key'] = key unless key.nil?
676
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
677
+ end
678
+ end
679
+ end
680
+ end
681
+ end