google-apis-toolresults_v1beta3 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,1355 @@
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 ToolresultsV1beta3
23
+ # Cloud Tool Results API
24
+ #
25
+ # API to publish and access results from developer tools.
26
+ #
27
+ # @example
28
+ # require 'google/apis/toolresults_v1beta3'
29
+ #
30
+ # Toolresults = Google::Apis::ToolresultsV1beta3 # Alias the module
31
+ # service = Toolresults::ToolResultsService.new
32
+ #
33
+ # @see https://firebase.google.com/docs/test-lab/
34
+ class ToolResultsService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://toolresults.googleapis.com/', '',
47
+ client_name: 'google-apis-toolresults_v1beta3',
48
+ client_version: Google::Apis::ToolresultsV1beta3::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Gets the Tool Results settings for a project. May return any of the following
53
+ # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to
54
+ # read from project
55
+ # @param [String] project_id
56
+ # A Project id. Required.
57
+ # @param [String] fields
58
+ # Selector specifying which fields to include in a partial response.
59
+ # @param [String] quota_user
60
+ # Available to use for quota purposes for server-side applications. Can be any
61
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
62
+ # @param [Google::Apis::RequestOptions] options
63
+ # Request-specific options
64
+ #
65
+ # @yield [result, err] Result & error if block supplied
66
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ProjectSettings] parsed result object
67
+ # @yieldparam err [StandardError] error object if request failed
68
+ #
69
+ # @return [Google::Apis::ToolresultsV1beta3::ProjectSettings]
70
+ #
71
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
72
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
73
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
74
+ def get_project_settings(project_id, fields: nil, quota_user: nil, options: nil, &block)
75
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/settings', options)
76
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ProjectSettings::Representation
77
+ command.response_class = Google::Apis::ToolresultsV1beta3::ProjectSettings
78
+ command.params['projectId'] = project_id unless project_id.nil?
79
+ command.query['fields'] = fields unless fields.nil?
80
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
81
+ execute_or_queue_command(command, &block)
82
+ end
83
+
84
+ # Creates resources for settings which have not yet been set. Currently, this
85
+ # creates a single resource: a Google Cloud Storage bucket, to be used as the
86
+ # default bucket for this project. The bucket is created in an FTL-own storage
87
+ # project. Except for in rare cases, calling this method in parallel from
88
+ # multiple clients will only create a single bucket. In order to avoid
89
+ # unnecessary storage charges, the bucket is configured to automatically delete
90
+ # objects older than 90 days. The bucket is created with the following
91
+ # permissions: - Owner access for owners of central storage project (FTL-owned) -
92
+ # Writer access for owners/editors of customer project - Reader access for
93
+ # viewers of customer project The default ACL on objects created in the bucket
94
+ # is: - Owner access for owners of central storage project - Reader access for
95
+ # owners/editors/viewers of customer project See Google Cloud Storage
96
+ # documentation for more details. If there is already a default bucket set and
97
+ # the project can access the bucket, this call does nothing. However, if the
98
+ # project doesn't have the permission to access the bucket or the bucket is
99
+ # deleted, a new bucket will be created. May return any canonical error codes,
100
+ # including the following: - PERMISSION_DENIED - if the user is not authorized
101
+ # to write to project - Any error code raised by Google Cloud Storage
102
+ # @param [String] project_id
103
+ # A Project id. Required.
104
+ # @param [String] fields
105
+ # Selector specifying which fields to include in a partial response.
106
+ # @param [String] quota_user
107
+ # Available to use for quota purposes for server-side applications. Can be any
108
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
109
+ # @param [Google::Apis::RequestOptions] options
110
+ # Request-specific options
111
+ #
112
+ # @yield [result, err] Result & error if block supplied
113
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ProjectSettings] parsed result object
114
+ # @yieldparam err [StandardError] error object if request failed
115
+ #
116
+ # @return [Google::Apis::ToolresultsV1beta3::ProjectSettings]
117
+ #
118
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
119
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
120
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
121
+ def initialize_project_settings(project_id, fields: nil, quota_user: nil, options: nil, &block)
122
+ command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}:initializeSettings', options)
123
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ProjectSettings::Representation
124
+ command.response_class = Google::Apis::ToolresultsV1beta3::ProjectSettings
125
+ command.params['projectId'] = project_id unless project_id.nil?
126
+ command.query['fields'] = fields unless fields.nil?
127
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
128
+ execute_or_queue_command(command, &block)
129
+ end
130
+
131
+ # Creates a History. The returned History will have the id set. May return any
132
+ # of the following canonical error codes: - PERMISSION_DENIED - if the user is
133
+ # not authorized to write to project - INVALID_ARGUMENT - if the request is
134
+ # malformed - NOT_FOUND - if the containing project does not exist
135
+ # @param [String] project_id
136
+ # A Project id. Required.
137
+ # @param [Google::Apis::ToolresultsV1beta3::History] history_object
138
+ # @param [String] request_id
139
+ # A unique request ID for server to detect duplicated requests. For example, a
140
+ # UUID. Optional, but strongly recommended.
141
+ # @param [String] fields
142
+ # Selector specifying which fields to include in a partial response.
143
+ # @param [String] quota_user
144
+ # Available to use for quota purposes for server-side applications. Can be any
145
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
146
+ # @param [Google::Apis::RequestOptions] options
147
+ # Request-specific options
148
+ #
149
+ # @yield [result, err] Result & error if block supplied
150
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::History] parsed result object
151
+ # @yieldparam err [StandardError] error object if request failed
152
+ #
153
+ # @return [Google::Apis::ToolresultsV1beta3::History]
154
+ #
155
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
156
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
157
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
158
+ def create_project_history(project_id, history_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
159
+ command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories', options)
160
+ command.request_representation = Google::Apis::ToolresultsV1beta3::History::Representation
161
+ command.request_object = history_object
162
+ command.response_representation = Google::Apis::ToolresultsV1beta3::History::Representation
163
+ command.response_class = Google::Apis::ToolresultsV1beta3::History
164
+ command.params['projectId'] = project_id unless project_id.nil?
165
+ command.query['requestId'] = request_id unless request_id.nil?
166
+ command.query['fields'] = fields unless fields.nil?
167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
168
+ execute_or_queue_command(command, &block)
169
+ end
170
+
171
+ # Gets a History. May return any of the following canonical error codes: -
172
+ # PERMISSION_DENIED - if the user is not authorized to read project -
173
+ # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History
174
+ # does not exist
175
+ # @param [String] project_id
176
+ # A Project id. Required.
177
+ # @param [String] history_id
178
+ # A History id. Required.
179
+ # @param [String] fields
180
+ # Selector specifying which fields to include in a partial response.
181
+ # @param [String] quota_user
182
+ # Available to use for quota purposes for server-side applications. Can be any
183
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
184
+ # @param [Google::Apis::RequestOptions] options
185
+ # Request-specific options
186
+ #
187
+ # @yield [result, err] Result & error if block supplied
188
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::History] parsed result object
189
+ # @yieldparam err [StandardError] error object if request failed
190
+ #
191
+ # @return [Google::Apis::ToolresultsV1beta3::History]
192
+ #
193
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
194
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
195
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
196
+ def get_project_history(project_id, history_id, fields: nil, quota_user: nil, options: nil, &block)
197
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}', options)
198
+ command.response_representation = Google::Apis::ToolresultsV1beta3::History::Representation
199
+ command.response_class = Google::Apis::ToolresultsV1beta3::History
200
+ command.params['projectId'] = project_id unless project_id.nil?
201
+ command.params['historyId'] = history_id unless history_id.nil?
202
+ command.query['fields'] = fields unless fields.nil?
203
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
204
+ execute_or_queue_command(command, &block)
205
+ end
206
+
207
+ # Lists Histories for a given Project. The histories are sorted by modification
208
+ # time in descending order. The history_id key will be used to order the history
209
+ # with the same modification time. May return any of the following canonical
210
+ # error codes: - PERMISSION_DENIED - if the user is not authorized to read
211
+ # project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the
212
+ # History does not exist
213
+ # @param [String] project_id
214
+ # A Project id. Required.
215
+ # @param [String] filter_by_name
216
+ # If set, only return histories with the given name. Optional.
217
+ # @param [Fixnum] page_size
218
+ # The maximum number of Histories to fetch. Default value: 20. The server will
219
+ # use this default if the field is not set or has a value of 0. Any value
220
+ # greater than 100 will be treated as 100. Optional.
221
+ # @param [String] page_token
222
+ # A continuation token to resume the query at the next item. Optional.
223
+ # @param [String] fields
224
+ # Selector specifying which fields to include in a partial response.
225
+ # @param [String] quota_user
226
+ # Available to use for quota purposes for server-side applications. Can be any
227
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
228
+ # @param [Google::Apis::RequestOptions] options
229
+ # Request-specific options
230
+ #
231
+ # @yield [result, err] Result & error if block supplied
232
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListHistoriesResponse] parsed result object
233
+ # @yieldparam err [StandardError] error object if request failed
234
+ #
235
+ # @return [Google::Apis::ToolresultsV1beta3::ListHistoriesResponse]
236
+ #
237
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
238
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
239
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
240
+ def list_project_histories(project_id, filter_by_name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
241
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories', options)
242
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListHistoriesResponse::Representation
243
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListHistoriesResponse
244
+ command.params['projectId'] = project_id unless project_id.nil?
245
+ command.query['filterByName'] = filter_by_name unless filter_by_name.nil?
246
+ command.query['pageSize'] = page_size unless page_size.nil?
247
+ command.query['pageToken'] = page_token unless page_token.nil?
248
+ command.query['fields'] = fields unless fields.nil?
249
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
250
+ execute_or_queue_command(command, &block)
251
+ end
252
+
253
+ # Creates an Execution. The returned Execution will have the id set. May return
254
+ # any of the following canonical error codes: - PERMISSION_DENIED - if the user
255
+ # is not authorized to write to project - INVALID_ARGUMENT - if the request is
256
+ # malformed - NOT_FOUND - if the containing History does not exist
257
+ # @param [String] project_id
258
+ # A Project id. Required.
259
+ # @param [String] history_id
260
+ # A History id. Required.
261
+ # @param [Google::Apis::ToolresultsV1beta3::Execution] execution_object
262
+ # @param [String] request_id
263
+ # A unique request ID for server to detect duplicated requests. For example, a
264
+ # UUID. Optional, but strongly recommended.
265
+ # @param [String] fields
266
+ # Selector specifying which fields to include in a partial response.
267
+ # @param [String] quota_user
268
+ # Available to use for quota purposes for server-side applications. Can be any
269
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
270
+ # @param [Google::Apis::RequestOptions] options
271
+ # Request-specific options
272
+ #
273
+ # @yield [result, err] Result & error if block supplied
274
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object
275
+ # @yieldparam err [StandardError] error object if request failed
276
+ #
277
+ # @return [Google::Apis::ToolresultsV1beta3::Execution]
278
+ #
279
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
280
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
281
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
282
+ def create_project_history_execution(project_id, history_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
283
+ command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions', options)
284
+ command.request_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
285
+ command.request_object = execution_object
286
+ command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
287
+ command.response_class = Google::Apis::ToolresultsV1beta3::Execution
288
+ command.params['projectId'] = project_id unless project_id.nil?
289
+ command.params['historyId'] = history_id unless history_id.nil?
290
+ command.query['requestId'] = request_id unless request_id.nil?
291
+ command.query['fields'] = fields unless fields.nil?
292
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
293
+ execute_or_queue_command(command, &block)
294
+ end
295
+
296
+ # Gets an Execution. May return any of the following canonical error codes: -
297
+ # PERMISSION_DENIED - if the user is not authorized to write to project -
298
+ # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution
299
+ # does not exist
300
+ # @param [String] project_id
301
+ # A Project id. Required.
302
+ # @param [String] history_id
303
+ # A History id. Required.
304
+ # @param [String] execution_id
305
+ # An Execution id. Required.
306
+ # @param [String] fields
307
+ # Selector specifying which fields to include in a partial response.
308
+ # @param [String] quota_user
309
+ # Available to use for quota purposes for server-side applications. Can be any
310
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
311
+ # @param [Google::Apis::RequestOptions] options
312
+ # Request-specific options
313
+ #
314
+ # @yield [result, err] Result & error if block supplied
315
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object
316
+ # @yieldparam err [StandardError] error object if request failed
317
+ #
318
+ # @return [Google::Apis::ToolresultsV1beta3::Execution]
319
+ #
320
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
321
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
322
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
323
+ def get_project_history_execution(project_id, history_id, execution_id, fields: nil, quota_user: nil, options: nil, &block)
324
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}', options)
325
+ command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
326
+ command.response_class = Google::Apis::ToolresultsV1beta3::Execution
327
+ command.params['projectId'] = project_id unless project_id.nil?
328
+ command.params['historyId'] = history_id unless history_id.nil?
329
+ command.params['executionId'] = execution_id unless execution_id.nil?
330
+ command.query['fields'] = fields unless fields.nil?
331
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
332
+ execute_or_queue_command(command, &block)
333
+ end
334
+
335
+ # Lists Executions for a given History. The executions are sorted by
336
+ # creation_time in descending order. The execution_id key will be used to order
337
+ # the executions with the same creation_time. May return any of the following
338
+ # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to
339
+ # read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if
340
+ # the containing History does not exist
341
+ # @param [String] project_id
342
+ # A Project id. Required.
343
+ # @param [String] history_id
344
+ # A History id. Required.
345
+ # @param [Fixnum] page_size
346
+ # The maximum number of Executions to fetch. Default value: 25. The server will
347
+ # use this default if the field is not set or has a value of 0. Optional.
348
+ # @param [String] page_token
349
+ # A continuation token to resume the query at the next item. Optional.
350
+ # @param [String] fields
351
+ # Selector specifying which fields to include in a partial response.
352
+ # @param [String] quota_user
353
+ # Available to use for quota purposes for server-side applications. Can be any
354
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
355
+ # @param [Google::Apis::RequestOptions] options
356
+ # Request-specific options
357
+ #
358
+ # @yield [result, err] Result & error if block supplied
359
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListExecutionsResponse] parsed result object
360
+ # @yieldparam err [StandardError] error object if request failed
361
+ #
362
+ # @return [Google::Apis::ToolresultsV1beta3::ListExecutionsResponse]
363
+ #
364
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
365
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
366
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
367
+ def list_project_history_executions(project_id, history_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
368
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions', options)
369
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListExecutionsResponse::Representation
370
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListExecutionsResponse
371
+ command.params['projectId'] = project_id unless project_id.nil?
372
+ command.params['historyId'] = history_id unless history_id.nil?
373
+ command.query['pageSize'] = page_size unless page_size.nil?
374
+ command.query['pageToken'] = page_token unless page_token.nil?
375
+ command.query['fields'] = fields unless fields.nil?
376
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
377
+ execute_or_queue_command(command, &block)
378
+ end
379
+
380
+ # Updates an existing Execution with the supplied partial entity. May return any
381
+ # of the following canonical error codes: - PERMISSION_DENIED - if the user is
382
+ # not authorized to write to project - INVALID_ARGUMENT - if the request is
383
+ # malformed - FAILED_PRECONDITION - if the requested state transition is illegal
384
+ # - NOT_FOUND - if the containing History does not exist
385
+ # @param [String] project_id
386
+ # A Project id. Required.
387
+ # @param [String] history_id
388
+ # Required.
389
+ # @param [String] execution_id
390
+ # Required.
391
+ # @param [Google::Apis::ToolresultsV1beta3::Execution] execution_object
392
+ # @param [String] request_id
393
+ # A unique request ID for server to detect duplicated requests. For example, a
394
+ # UUID. Optional, but strongly recommended.
395
+ # @param [String] fields
396
+ # Selector specifying which fields to include in a partial response.
397
+ # @param [String] quota_user
398
+ # Available to use for quota purposes for server-side applications. Can be any
399
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
400
+ # @param [Google::Apis::RequestOptions] options
401
+ # Request-specific options
402
+ #
403
+ # @yield [result, err] Result & error if block supplied
404
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::Execution] parsed result object
405
+ # @yieldparam err [StandardError] error object if request failed
406
+ #
407
+ # @return [Google::Apis::ToolresultsV1beta3::Execution]
408
+ #
409
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
410
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
411
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
412
+ def patch_project_history_execution(project_id, history_id, execution_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
413
+ command = make_simple_command(:patch, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}', options)
414
+ command.request_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
415
+ command.request_object = execution_object
416
+ command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
417
+ command.response_class = Google::Apis::ToolresultsV1beta3::Execution
418
+ command.params['projectId'] = project_id unless project_id.nil?
419
+ command.params['historyId'] = history_id unless history_id.nil?
420
+ command.params['executionId'] = execution_id unless execution_id.nil?
421
+ command.query['requestId'] = request_id unless request_id.nil?
422
+ command.query['fields'] = fields unless fields.nil?
423
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
424
+ execute_or_queue_command(command, &block)
425
+ end
426
+
427
+ # Retrieves a single screenshot cluster by its ID
428
+ # @param [String] project_id
429
+ # A Project id. Required.
430
+ # @param [String] history_id
431
+ # A History id. Required.
432
+ # @param [String] execution_id
433
+ # An Execution id. Required.
434
+ # @param [String] cluster_id
435
+ # A Cluster id Required.
436
+ # @param [String] fields
437
+ # Selector specifying which fields to include in a partial response.
438
+ # @param [String] quota_user
439
+ # Available to use for quota purposes for server-side applications. Can be any
440
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
441
+ # @param [Google::Apis::RequestOptions] options
442
+ # Request-specific options
443
+ #
444
+ # @yield [result, err] Result & error if block supplied
445
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ScreenshotCluster] parsed result object
446
+ # @yieldparam err [StandardError] error object if request failed
447
+ #
448
+ # @return [Google::Apis::ToolresultsV1beta3::ScreenshotCluster]
449
+ #
450
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
451
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
452
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
453
+ def get_project_history_execution_cluster(project_id, history_id, execution_id, cluster_id, fields: nil, quota_user: nil, options: nil, &block)
454
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}', options)
455
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ScreenshotCluster::Representation
456
+ command.response_class = Google::Apis::ToolresultsV1beta3::ScreenshotCluster
457
+ command.params['projectId'] = project_id unless project_id.nil?
458
+ command.params['historyId'] = history_id unless history_id.nil?
459
+ command.params['executionId'] = execution_id unless execution_id.nil?
460
+ command.params['clusterId'] = cluster_id unless cluster_id.nil?
461
+ command.query['fields'] = fields unless fields.nil?
462
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
463
+ execute_or_queue_command(command, &block)
464
+ end
465
+
466
+ # Lists Screenshot Clusters Returns the list of screenshot clusters
467
+ # corresponding to an execution. Screenshot clusters are created after the
468
+ # execution is finished. Clusters are created from a set of screenshots. Between
469
+ # any two screenshots, a matching score is calculated based off their metadata
470
+ # that determines how similar they are. Screenshots are placed in the cluster
471
+ # that has screens which have the highest matching scores.
472
+ # @param [String] project_id
473
+ # A Project id. Required.
474
+ # @param [String] history_id
475
+ # A History id. Required.
476
+ # @param [String] execution_id
477
+ # An Execution id. Required.
478
+ # @param [String] fields
479
+ # Selector specifying which fields to include in a partial response.
480
+ # @param [String] quota_user
481
+ # Available to use for quota purposes for server-side applications. Can be any
482
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
483
+ # @param [Google::Apis::RequestOptions] options
484
+ # Request-specific options
485
+ #
486
+ # @yield [result, err] Result & error if block supplied
487
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse] parsed result object
488
+ # @yieldparam err [StandardError] error object if request failed
489
+ #
490
+ # @return [Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse]
491
+ #
492
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
493
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
494
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
495
+ def list_project_history_execution_clusters(project_id, history_id, execution_id, fields: nil, quota_user: nil, options: nil, &block)
496
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters', options)
497
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse::Representation
498
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse
499
+ command.params['projectId'] = project_id unless project_id.nil?
500
+ command.params['historyId'] = history_id unless history_id.nil?
501
+ command.params['executionId'] = execution_id unless execution_id.nil?
502
+ command.query['fields'] = fields unless fields.nil?
503
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
504
+ execute_or_queue_command(command, &block)
505
+ end
506
+
507
+ # Gets an Environment. May return any of the following canonical error codes: -
508
+ # PERMISSION_DENIED - if the user is not authorized to read project -
509
+ # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the
510
+ # Environment does not exist
511
+ # @param [String] project_id
512
+ # Required. A Project id.
513
+ # @param [String] history_id
514
+ # Required. A History id.
515
+ # @param [String] execution_id
516
+ # Required. An Execution id.
517
+ # @param [String] environment_id
518
+ # Required. An Environment id.
519
+ # @param [String] fields
520
+ # Selector specifying which fields to include in a partial response.
521
+ # @param [String] quota_user
522
+ # Available to use for quota purposes for server-side applications. Can be any
523
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
524
+ # @param [Google::Apis::RequestOptions] options
525
+ # Request-specific options
526
+ #
527
+ # @yield [result, err] Result & error if block supplied
528
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::Environment] parsed result object
529
+ # @yieldparam err [StandardError] error object if request failed
530
+ #
531
+ # @return [Google::Apis::ToolresultsV1beta3::Environment]
532
+ #
533
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
534
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
535
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
536
+ def get_project_history_execution_environment(project_id, history_id, execution_id, environment_id, fields: nil, quota_user: nil, options: nil, &block)
537
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}', options)
538
+ command.response_representation = Google::Apis::ToolresultsV1beta3::Environment::Representation
539
+ command.response_class = Google::Apis::ToolresultsV1beta3::Environment
540
+ command.params['projectId'] = project_id unless project_id.nil?
541
+ command.params['historyId'] = history_id unless history_id.nil?
542
+ command.params['executionId'] = execution_id unless execution_id.nil?
543
+ command.params['environmentId'] = environment_id unless environment_id.nil?
544
+ command.query['fields'] = fields unless fields.nil?
545
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
546
+ execute_or_queue_command(command, &block)
547
+ end
548
+
549
+ # Lists Environments for a given Execution. The Environments are sorted by
550
+ # display name. May return any of the following canonical error codes: -
551
+ # PERMISSION_DENIED - if the user is not authorized to read project -
552
+ # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing
553
+ # Execution does not exist
554
+ # @param [String] project_id
555
+ # Required. A Project id.
556
+ # @param [String] history_id
557
+ # Required. A History id.
558
+ # @param [String] execution_id
559
+ # Required. An Execution id.
560
+ # @param [Fixnum] page_size
561
+ # The maximum number of Environments to fetch. Default value: 25. The server
562
+ # will use this default if the field is not set or has a value of 0.
563
+ # @param [String] page_token
564
+ # A continuation token to resume the query at the next item.
565
+ # @param [String] fields
566
+ # Selector specifying which fields to include in a partial response.
567
+ # @param [String] quota_user
568
+ # Available to use for quota purposes for server-side applications. Can be any
569
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
570
+ # @param [Google::Apis::RequestOptions] options
571
+ # Request-specific options
572
+ #
573
+ # @yield [result, err] Result & error if block supplied
574
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse] parsed result object
575
+ # @yieldparam err [StandardError] error object if request failed
576
+ #
577
+ # @return [Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse]
578
+ #
579
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
580
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
581
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
582
+ def list_project_history_execution_environments(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
583
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments', options)
584
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse::Representation
585
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse
586
+ command.params['projectId'] = project_id unless project_id.nil?
587
+ command.params['historyId'] = history_id unless history_id.nil?
588
+ command.params['executionId'] = execution_id unless execution_id.nil?
589
+ command.query['pageSize'] = page_size unless page_size.nil?
590
+ command.query['pageToken'] = page_token unless page_token.nil?
591
+ command.query['fields'] = fields unless fields.nil?
592
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
593
+ execute_or_queue_command(command, &block)
594
+ end
595
+
596
+ # Lists accessibility clusters for a given Step May return any of the following
597
+ # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to
598
+ # read project - INVALID_ARGUMENT - if the request is malformed -
599
+ # FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g.
600
+ # if the locale format is incorrect - NOT_FOUND - if the containing Step does
601
+ # not exist
602
+ # @param [String] name
603
+ # A full resource name of the step. For example, projects/my-project/histories/
604
+ # bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef
605
+ # Required.
606
+ # @param [String] locale
607
+ # The accepted format is the canonical Unicode format with hyphen as a delimiter.
608
+ # Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE.
609
+ # See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for
610
+ # details. Required.
611
+ # @param [String] fields
612
+ # Selector specifying which fields to include in a partial response.
613
+ # @param [String] quota_user
614
+ # Available to use for quota purposes for server-side applications. Can be any
615
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
616
+ # @param [Google::Apis::RequestOptions] options
617
+ # Request-specific options
618
+ #
619
+ # @yield [result, err] Result & error if block supplied
620
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse] parsed result object
621
+ # @yieldparam err [StandardError] error object if request failed
622
+ #
623
+ # @return [Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse]
624
+ #
625
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
626
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
627
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
628
+ def accessibility_project_history_execution_step_clusters(name, locale: nil, fields: nil, quota_user: nil, options: nil, &block)
629
+ command = make_simple_command(:get, 'toolresults/v1beta3/{+name}:accessibilityClusters', options)
630
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse::Representation
631
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse
632
+ command.params['name'] = name unless name.nil?
633
+ command.query['locale'] = locale unless locale.nil?
634
+ command.query['fields'] = fields unless fields.nil?
635
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
636
+ execute_or_queue_command(command, &block)
637
+ end
638
+
639
+ # Creates a Step. The returned Step will have the id set. May return any of the
640
+ # following canonical error codes: - PERMISSION_DENIED - if the user is not
641
+ # authorized to write to project - INVALID_ARGUMENT - if the request is
642
+ # malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) -
643
+ # NOT_FOUND - if the containing Execution does not exist
644
+ # @param [String] project_id
645
+ # Required. A Project id.
646
+ # @param [String] history_id
647
+ # Required. A History id.
648
+ # @param [String] execution_id
649
+ # Required. An Execution id.
650
+ # @param [Google::Apis::ToolresultsV1beta3::Step] step_object
651
+ # @param [String] request_id
652
+ # A unique request ID for server to detect duplicated requests. For example, a
653
+ # UUID. Optional, but strongly recommended.
654
+ # @param [String] fields
655
+ # Selector specifying which fields to include in a partial response.
656
+ # @param [String] quota_user
657
+ # Available to use for quota purposes for server-side applications. Can be any
658
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
659
+ # @param [Google::Apis::RequestOptions] options
660
+ # Request-specific options
661
+ #
662
+ # @yield [result, err] Result & error if block supplied
663
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object
664
+ # @yieldparam err [StandardError] error object if request failed
665
+ #
666
+ # @return [Google::Apis::ToolresultsV1beta3::Step]
667
+ #
668
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
669
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
670
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
671
+ def create_project_history_execution_step(project_id, history_id, execution_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
672
+ command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps', options)
673
+ command.request_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
674
+ command.request_object = step_object
675
+ command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
676
+ command.response_class = Google::Apis::ToolresultsV1beta3::Step
677
+ command.params['projectId'] = project_id unless project_id.nil?
678
+ command.params['historyId'] = history_id unless history_id.nil?
679
+ command.params['executionId'] = execution_id unless execution_id.nil?
680
+ command.query['requestId'] = request_id unless request_id.nil?
681
+ command.query['fields'] = fields unless fields.nil?
682
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
683
+ execute_or_queue_command(command, &block)
684
+ end
685
+
686
+ # Gets a Step. May return any of the following canonical error codes: -
687
+ # PERMISSION_DENIED - if the user is not authorized to read project -
688
+ # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does
689
+ # not exist
690
+ # @param [String] project_id
691
+ # A Project id. Required.
692
+ # @param [String] history_id
693
+ # A History id. Required.
694
+ # @param [String] execution_id
695
+ # A Execution id. Required.
696
+ # @param [String] step_id
697
+ # A Step id. Required.
698
+ # @param [String] fields
699
+ # Selector specifying which fields to include in a partial response.
700
+ # @param [String] quota_user
701
+ # Available to use for quota purposes for server-side applications. Can be any
702
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
703
+ # @param [Google::Apis::RequestOptions] options
704
+ # Request-specific options
705
+ #
706
+ # @yield [result, err] Result & error if block supplied
707
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object
708
+ # @yieldparam err [StandardError] error object if request failed
709
+ #
710
+ # @return [Google::Apis::ToolresultsV1beta3::Step]
711
+ #
712
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
713
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
714
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
715
+ def get_project_history_execution_step(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, options: nil, &block)
716
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}', options)
717
+ command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
718
+ command.response_class = Google::Apis::ToolresultsV1beta3::Step
719
+ command.params['projectId'] = project_id unless project_id.nil?
720
+ command.params['historyId'] = history_id unless history_id.nil?
721
+ command.params['executionId'] = execution_id unless execution_id.nil?
722
+ command.params['stepId'] = step_id unless step_id.nil?
723
+ command.query['fields'] = fields unless fields.nil?
724
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
725
+ execute_or_queue_command(command, &block)
726
+ end
727
+
728
+ # Retrieves a PerfMetricsSummary. May return any of the following error code(s):
729
+ # - NOT_FOUND - The specified PerfMetricsSummary does not exist
730
+ # @param [String] project_id
731
+ # The cloud project
732
+ # @param [String] history_id
733
+ # A tool results history ID.
734
+ # @param [String] execution_id
735
+ # A tool results execution ID.
736
+ # @param [String] step_id
737
+ # A tool results step ID.
738
+ # @param [String] fields
739
+ # Selector specifying which fields to include in a partial response.
740
+ # @param [String] quota_user
741
+ # Available to use for quota purposes for server-side applications. Can be any
742
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
743
+ # @param [Google::Apis::RequestOptions] options
744
+ # Request-specific options
745
+ #
746
+ # @yield [result, err] Result & error if block supplied
747
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary] parsed result object
748
+ # @yieldparam err [StandardError] error object if request failed
749
+ #
750
+ # @return [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary]
751
+ #
752
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
753
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
754
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
755
+ def get_project_history_execution_step_perf_metrics_summary(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, options: nil, &block)
756
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary', options)
757
+ command.response_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation
758
+ command.response_class = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary
759
+ command.params['projectId'] = project_id unless project_id.nil?
760
+ command.params['historyId'] = history_id unless history_id.nil?
761
+ command.params['executionId'] = execution_id unless execution_id.nil?
762
+ command.params['stepId'] = step_id unless step_id.nil?
763
+ command.query['fields'] = fields unless fields.nil?
764
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
765
+ execute_or_queue_command(command, &block)
766
+ end
767
+
768
+ # Lists Steps for a given Execution. The steps are sorted by creation_time in
769
+ # descending order. The step_id key will be used to order the steps with the
770
+ # same creation_time. May return any of the following canonical error codes: -
771
+ # PERMISSION_DENIED - if the user is not authorized to read project -
772
+ # INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an
773
+ # argument in the request happens to be invalid; e.g. if an attempt is made to
774
+ # list the children of a nonexistent Step - NOT_FOUND - if the containing
775
+ # Execution does not exist
776
+ # @param [String] project_id
777
+ # A Project id. Required.
778
+ # @param [String] history_id
779
+ # A History id. Required.
780
+ # @param [String] execution_id
781
+ # A Execution id. Required.
782
+ # @param [Fixnum] page_size
783
+ # The maximum number of Steps to fetch. Default value: 25. The server will use
784
+ # this default if the field is not set or has a value of 0. Optional.
785
+ # @param [String] page_token
786
+ # A continuation token to resume the query at the next item. Optional.
787
+ # @param [String] fields
788
+ # Selector specifying which fields to include in a partial response.
789
+ # @param [String] quota_user
790
+ # Available to use for quota purposes for server-side applications. Can be any
791
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
792
+ # @param [Google::Apis::RequestOptions] options
793
+ # Request-specific options
794
+ #
795
+ # @yield [result, err] Result & error if block supplied
796
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListStepsResponse] parsed result object
797
+ # @yieldparam err [StandardError] error object if request failed
798
+ #
799
+ # @return [Google::Apis::ToolresultsV1beta3::ListStepsResponse]
800
+ #
801
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
802
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
803
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
804
+ def list_project_history_execution_steps(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
805
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps', options)
806
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepsResponse::Representation
807
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListStepsResponse
808
+ command.params['projectId'] = project_id unless project_id.nil?
809
+ command.params['historyId'] = history_id unless history_id.nil?
810
+ command.params['executionId'] = execution_id unless execution_id.nil?
811
+ command.query['pageSize'] = page_size unless page_size.nil?
812
+ command.query['pageToken'] = page_token unless page_token.nil?
813
+ command.query['fields'] = fields unless fields.nil?
814
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
815
+ execute_or_queue_command(command, &block)
816
+ end
817
+
818
+ # Updates an existing Step with the supplied partial entity. May return any of
819
+ # the following canonical error codes: - PERMISSION_DENIED - if the user is not
820
+ # authorized to write project - INVALID_ARGUMENT - if the request is malformed -
821
+ # FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to
822
+ # upload a duplicate xml file), if the updated step is too large (more than
823
+ # 10Mib) - NOT_FOUND - if the containing Execution does not exist
824
+ # @param [String] project_id
825
+ # A Project id. Required.
826
+ # @param [String] history_id
827
+ # A History id. Required.
828
+ # @param [String] execution_id
829
+ # A Execution id. Required.
830
+ # @param [String] step_id
831
+ # A Step id. Required.
832
+ # @param [Google::Apis::ToolresultsV1beta3::Step] step_object
833
+ # @param [String] request_id
834
+ # A unique request ID for server to detect duplicated requests. For example, a
835
+ # UUID. Optional, but strongly recommended.
836
+ # @param [String] fields
837
+ # Selector specifying which fields to include in a partial response.
838
+ # @param [String] quota_user
839
+ # Available to use for quota purposes for server-side applications. Can be any
840
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
841
+ # @param [Google::Apis::RequestOptions] options
842
+ # Request-specific options
843
+ #
844
+ # @yield [result, err] Result & error if block supplied
845
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object
846
+ # @yieldparam err [StandardError] error object if request failed
847
+ #
848
+ # @return [Google::Apis::ToolresultsV1beta3::Step]
849
+ #
850
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
851
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
852
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
853
+ def patch_project_history_execution_step(project_id, history_id, execution_id, step_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
854
+ command = make_simple_command(:patch, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}', options)
855
+ command.request_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
856
+ command.request_object = step_object
857
+ command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
858
+ command.response_class = Google::Apis::ToolresultsV1beta3::Step
859
+ command.params['projectId'] = project_id unless project_id.nil?
860
+ command.params['historyId'] = history_id unless history_id.nil?
861
+ command.params['executionId'] = execution_id unless execution_id.nil?
862
+ command.params['stepId'] = step_id unless step_id.nil?
863
+ command.query['requestId'] = request_id unless request_id.nil?
864
+ command.query['fields'] = fields unless fields.nil?
865
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
866
+ execute_or_queue_command(command, &block)
867
+ end
868
+
869
+ # Publish xml files to an existing Step. May return any of the following
870
+ # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to
871
+ # write project - INVALID_ARGUMENT - if the request is malformed -
872
+ # FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to
873
+ # upload a duplicate xml file or a file too large. - NOT_FOUND - if the
874
+ # containing Execution does not exist
875
+ # @param [String] project_id
876
+ # A Project id. Required.
877
+ # @param [String] history_id
878
+ # A History id. Required.
879
+ # @param [String] execution_id
880
+ # A Execution id. Required.
881
+ # @param [String] step_id
882
+ # A Step id. Note: This step must include a TestExecutionStep. Required.
883
+ # @param [Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest] publish_xunit_xml_files_request_object
884
+ # @param [String] fields
885
+ # Selector specifying which fields to include in a partial response.
886
+ # @param [String] quota_user
887
+ # Available to use for quota purposes for server-side applications. Can be any
888
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
889
+ # @param [Google::Apis::RequestOptions] options
890
+ # Request-specific options
891
+ #
892
+ # @yield [result, err] Result & error if block supplied
893
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::Step] parsed result object
894
+ # @yieldparam err [StandardError] error object if request failed
895
+ #
896
+ # @return [Google::Apis::ToolresultsV1beta3::Step]
897
+ #
898
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
899
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
900
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
901
+ def publish_step_xunit_xml_files(project_id, history_id, execution_id, step_id, publish_xunit_xml_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
902
+ command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles', options)
903
+ command.request_representation = Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest::Representation
904
+ command.request_object = publish_xunit_xml_files_request_object
905
+ command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
906
+ command.response_class = Google::Apis::ToolresultsV1beta3::Step
907
+ command.params['projectId'] = project_id unless project_id.nil?
908
+ command.params['historyId'] = history_id unless history_id.nil?
909
+ command.params['executionId'] = execution_id unless execution_id.nil?
910
+ command.params['stepId'] = step_id unless step_id.nil?
911
+ command.query['fields'] = fields unless fields.nil?
912
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
913
+ execute_or_queue_command(command, &block)
914
+ end
915
+
916
+ # Creates a PerfMetricsSummary resource. Returns the existing one if it has
917
+ # already been created. May return any of the following error code(s): -
918
+ # NOT_FOUND - The containing Step does not exist
919
+ # @param [String] project_id
920
+ # The cloud project
921
+ # @param [String] history_id
922
+ # A tool results history ID.
923
+ # @param [String] execution_id
924
+ # A tool results execution ID.
925
+ # @param [String] step_id
926
+ # A tool results step ID.
927
+ # @param [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary] perf_metrics_summary_object
928
+ # @param [String] fields
929
+ # Selector specifying which fields to include in a partial response.
930
+ # @param [String] quota_user
931
+ # Available to use for quota purposes for server-side applications. Can be any
932
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
933
+ # @param [Google::Apis::RequestOptions] options
934
+ # Request-specific options
935
+ #
936
+ # @yield [result, err] Result & error if block supplied
937
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary] parsed result object
938
+ # @yieldparam err [StandardError] error object if request failed
939
+ #
940
+ # @return [Google::Apis::ToolresultsV1beta3::PerfMetricsSummary]
941
+ #
942
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
943
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
944
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
945
+ def create_project_history_execution_step_perf_metrics_summary(project_id, history_id, execution_id, step_id, perf_metrics_summary_object = nil, fields: nil, quota_user: nil, options: nil, &block)
946
+ command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary', options)
947
+ command.request_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation
948
+ command.request_object = perf_metrics_summary_object
949
+ command.response_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation
950
+ command.response_class = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary
951
+ command.params['projectId'] = project_id unless project_id.nil?
952
+ command.params['historyId'] = history_id unless history_id.nil?
953
+ command.params['executionId'] = execution_id unless execution_id.nil?
954
+ command.params['stepId'] = step_id unless step_id.nil?
955
+ command.query['fields'] = fields unless fields.nil?
956
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
957
+ execute_or_queue_command(command, &block)
958
+ end
959
+
960
+ # Creates a PerfSampleSeries. May return any of the following error code(s): -
961
+ # ALREADY_EXISTS - PerfMetricSummary already exists for the given Step -
962
+ # NOT_FOUND - The containing Step does not exist
963
+ # @param [String] project_id
964
+ # The cloud project
965
+ # @param [String] history_id
966
+ # A tool results history ID.
967
+ # @param [String] execution_id
968
+ # A tool results execution ID.
969
+ # @param [String] step_id
970
+ # A tool results step ID.
971
+ # @param [Google::Apis::ToolresultsV1beta3::PerfSampleSeries] perf_sample_series_object
972
+ # @param [String] fields
973
+ # Selector specifying which fields to include in a partial response.
974
+ # @param [String] quota_user
975
+ # Available to use for quota purposes for server-side applications. Can be any
976
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
977
+ # @param [Google::Apis::RequestOptions] options
978
+ # Request-specific options
979
+ #
980
+ # @yield [result, err] Result & error if block supplied
981
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::PerfSampleSeries] parsed result object
982
+ # @yieldparam err [StandardError] error object if request failed
983
+ #
984
+ # @return [Google::Apis::ToolresultsV1beta3::PerfSampleSeries]
985
+ #
986
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
987
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
988
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
989
+ def create_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, perf_sample_series_object = nil, fields: nil, quota_user: nil, options: nil, &block)
990
+ command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries', options)
991
+ command.request_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation
992
+ command.request_object = perf_sample_series_object
993
+ command.response_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation
994
+ command.response_class = Google::Apis::ToolresultsV1beta3::PerfSampleSeries
995
+ command.params['projectId'] = project_id unless project_id.nil?
996
+ command.params['historyId'] = history_id unless history_id.nil?
997
+ command.params['executionId'] = execution_id unless execution_id.nil?
998
+ command.params['stepId'] = step_id unless step_id.nil?
999
+ command.query['fields'] = fields unless fields.nil?
1000
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1001
+ execute_or_queue_command(command, &block)
1002
+ end
1003
+
1004
+ # Gets a PerfSampleSeries. May return any of the following error code(s): -
1005
+ # NOT_FOUND - The specified PerfSampleSeries does not exist
1006
+ # @param [String] project_id
1007
+ # The cloud project
1008
+ # @param [String] history_id
1009
+ # A tool results history ID.
1010
+ # @param [String] execution_id
1011
+ # A tool results execution ID.
1012
+ # @param [String] step_id
1013
+ # A tool results step ID.
1014
+ # @param [String] sample_series_id
1015
+ # A sample series id
1016
+ # @param [String] fields
1017
+ # Selector specifying which fields to include in a partial response.
1018
+ # @param [String] quota_user
1019
+ # Available to use for quota purposes for server-side applications. Can be any
1020
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1021
+ # @param [Google::Apis::RequestOptions] options
1022
+ # Request-specific options
1023
+ #
1024
+ # @yield [result, err] Result & error if block supplied
1025
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::PerfSampleSeries] parsed result object
1026
+ # @yieldparam err [StandardError] error object if request failed
1027
+ #
1028
+ # @return [Google::Apis::ToolresultsV1beta3::PerfSampleSeries]
1029
+ #
1030
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1031
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1032
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1033
+ def get_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, sample_series_id, fields: nil, quota_user: nil, options: nil, &block)
1034
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}', options)
1035
+ command.response_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation
1036
+ command.response_class = Google::Apis::ToolresultsV1beta3::PerfSampleSeries
1037
+ command.params['projectId'] = project_id unless project_id.nil?
1038
+ command.params['historyId'] = history_id unless history_id.nil?
1039
+ command.params['executionId'] = execution_id unless execution_id.nil?
1040
+ command.params['stepId'] = step_id unless step_id.nil?
1041
+ command.params['sampleSeriesId'] = sample_series_id unless sample_series_id.nil?
1042
+ command.query['fields'] = fields unless fields.nil?
1043
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1044
+ execute_or_queue_command(command, &block)
1045
+ end
1046
+
1047
+ # Lists PerfSampleSeries for a given Step. The request provides an optional
1048
+ # filter which specifies one or more PerfMetricsType to include in the result;
1049
+ # if none returns all. The resulting PerfSampleSeries are sorted by ids. May
1050
+ # return any of the following canonical error codes: - NOT_FOUND - The
1051
+ # containing Step does not exist
1052
+ # @param [String] project_id
1053
+ # The cloud project
1054
+ # @param [String] history_id
1055
+ # A tool results history ID.
1056
+ # @param [String] execution_id
1057
+ # A tool results execution ID.
1058
+ # @param [String] step_id
1059
+ # A tool results step ID.
1060
+ # @param [Array<String>, String] filter
1061
+ # Specify one or more PerfMetricType values such as CPU to filter the result
1062
+ # @param [String] fields
1063
+ # Selector specifying which fields to include in a partial response.
1064
+ # @param [String] quota_user
1065
+ # Available to use for quota purposes for server-side applications. Can be any
1066
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1067
+ # @param [Google::Apis::RequestOptions] options
1068
+ # Request-specific options
1069
+ #
1070
+ # @yield [result, err] Result & error if block supplied
1071
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse] parsed result object
1072
+ # @yieldparam err [StandardError] error object if request failed
1073
+ #
1074
+ # @return [Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse]
1075
+ #
1076
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1077
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1078
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1079
+ def list_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
1080
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries', options)
1081
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse::Representation
1082
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse
1083
+ command.params['projectId'] = project_id unless project_id.nil?
1084
+ command.params['historyId'] = history_id unless history_id.nil?
1085
+ command.params['executionId'] = execution_id unless execution_id.nil?
1086
+ command.params['stepId'] = step_id unless step_id.nil?
1087
+ command.query['filter'] = filter unless filter.nil?
1088
+ command.query['fields'] = fields unless fields.nil?
1089
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1090
+ execute_or_queue_command(command, &block)
1091
+ end
1092
+
1093
+ # Creates a batch of PerfSamples - a client can submit multiple batches of Perf
1094
+ # Samples through repeated calls to this method in order to split up a large
1095
+ # request payload - duplicates and existing timestamp entries will be ignored. -
1096
+ # the batch operation may partially succeed - the set of elements successfully
1097
+ # inserted is returned in the response (omits items which already existed in the
1098
+ # database). May return any of the following canonical error codes: - NOT_FOUND -
1099
+ # The containing PerfSampleSeries does not exist
1100
+ # @param [String] project_id
1101
+ # The cloud project
1102
+ # @param [String] history_id
1103
+ # A tool results history ID.
1104
+ # @param [String] execution_id
1105
+ # A tool results execution ID.
1106
+ # @param [String] step_id
1107
+ # A tool results step ID.
1108
+ # @param [String] sample_series_id
1109
+ # A sample series id
1110
+ # @param [Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesRequest] batch_create_perf_samples_request_object
1111
+ # @param [String] fields
1112
+ # Selector specifying which fields to include in a partial response.
1113
+ # @param [String] quota_user
1114
+ # Available to use for quota purposes for server-side applications. Can be any
1115
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1116
+ # @param [Google::Apis::RequestOptions] options
1117
+ # Request-specific options
1118
+ #
1119
+ # @yield [result, err] Result & error if block supplied
1120
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesResponse] parsed result object
1121
+ # @yieldparam err [StandardError] error object if request failed
1122
+ #
1123
+ # @return [Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesResponse]
1124
+ #
1125
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1126
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1127
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1128
+ def batch_create_perf_samples(project_id, history_id, execution_id, step_id, sample_series_id, batch_create_perf_samples_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1129
+ command = make_simple_command(:post, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate', options)
1130
+ command.request_representation = Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesRequest::Representation
1131
+ command.request_object = batch_create_perf_samples_request_object
1132
+ command.response_representation = Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesResponse::Representation
1133
+ command.response_class = Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesResponse
1134
+ command.params['projectId'] = project_id unless project_id.nil?
1135
+ command.params['historyId'] = history_id unless history_id.nil?
1136
+ command.params['executionId'] = execution_id unless execution_id.nil?
1137
+ command.params['stepId'] = step_id unless step_id.nil?
1138
+ command.params['sampleSeriesId'] = sample_series_id unless sample_series_id.nil?
1139
+ command.query['fields'] = fields unless fields.nil?
1140
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1141
+ execute_or_queue_command(command, &block)
1142
+ end
1143
+
1144
+ # Lists the Performance Samples of a given Sample Series - The list results are
1145
+ # sorted by timestamps ascending - The default page size is 500 samples; and
1146
+ # maximum size allowed 5000 - The response token indicates the last returned
1147
+ # PerfSample timestamp - When the results size exceeds the page size, submit a
1148
+ # subsequent request including the page token to return the rest of the samples
1149
+ # up to the page limit May return any of the following canonical error codes: -
1150
+ # OUT_OF_RANGE - The specified request page_token is out of valid range -
1151
+ # NOT_FOUND - The containing PerfSampleSeries does not exist
1152
+ # @param [String] project_id
1153
+ # The cloud project
1154
+ # @param [String] history_id
1155
+ # A tool results history ID.
1156
+ # @param [String] execution_id
1157
+ # A tool results execution ID.
1158
+ # @param [String] step_id
1159
+ # A tool results step ID.
1160
+ # @param [String] sample_series_id
1161
+ # A sample series id
1162
+ # @param [Fixnum] page_size
1163
+ # The default page size is 500 samples, and the maximum size is 5000. If the
1164
+ # page_size is greater than 5000, the effective page size will be 5000
1165
+ # @param [String] page_token
1166
+ # Optional, the next_page_token returned in the previous response
1167
+ # @param [String] fields
1168
+ # Selector specifying which fields to include in a partial response.
1169
+ # @param [String] quota_user
1170
+ # Available to use for quota purposes for server-side applications. Can be any
1171
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1172
+ # @param [Google::Apis::RequestOptions] options
1173
+ # Request-specific options
1174
+ #
1175
+ # @yield [result, err] Result & error if block supplied
1176
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse] parsed result object
1177
+ # @yieldparam err [StandardError] error object if request failed
1178
+ #
1179
+ # @return [Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse]
1180
+ #
1181
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1182
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1183
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1184
+ def list_project_history_execution_step_perf_sample_series_samples(project_id, history_id, execution_id, step_id, sample_series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1185
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples', options)
1186
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse::Representation
1187
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse
1188
+ command.params['projectId'] = project_id unless project_id.nil?
1189
+ command.params['historyId'] = history_id unless history_id.nil?
1190
+ command.params['executionId'] = execution_id unless execution_id.nil?
1191
+ command.params['stepId'] = step_id unless step_id.nil?
1192
+ command.params['sampleSeriesId'] = sample_series_id unless sample_series_id.nil?
1193
+ command.query['pageSize'] = page_size unless page_size.nil?
1194
+ command.query['pageToken'] = page_token unless page_token.nil?
1195
+ command.query['fields'] = fields unless fields.nil?
1196
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1197
+ execute_or_queue_command(command, &block)
1198
+ end
1199
+
1200
+ # Gets details of a Test Case for a Step. Experimental test cases API. Still in
1201
+ # active development. May return any of the following canonical error codes: -
1202
+ # PERMISSION_DENIED - if the user is not authorized to write to project -
1203
+ # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing
1204
+ # Test Case does not exist
1205
+ # @param [String] project_id
1206
+ # A Project id. Required.
1207
+ # @param [String] history_id
1208
+ # A History id. Required.
1209
+ # @param [String] execution_id
1210
+ # A Execution id Required.
1211
+ # @param [String] step_id
1212
+ # A Step id. Note: This step must include a TestExecutionStep. Required.
1213
+ # @param [String] test_case_id
1214
+ # A Test Case id. Required.
1215
+ # @param [String] fields
1216
+ # Selector specifying which fields to include in a partial response.
1217
+ # @param [String] quota_user
1218
+ # Available to use for quota purposes for server-side applications. Can be any
1219
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1220
+ # @param [Google::Apis::RequestOptions] options
1221
+ # Request-specific options
1222
+ #
1223
+ # @yield [result, err] Result & error if block supplied
1224
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::TestCase] parsed result object
1225
+ # @yieldparam err [StandardError] error object if request failed
1226
+ #
1227
+ # @return [Google::Apis::ToolresultsV1beta3::TestCase]
1228
+ #
1229
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1230
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1231
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1232
+ def get_project_history_execution_step_test_case(project_id, history_id, execution_id, step_id, test_case_id, fields: nil, quota_user: nil, options: nil, &block)
1233
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}', options)
1234
+ command.response_representation = Google::Apis::ToolresultsV1beta3::TestCase::Representation
1235
+ command.response_class = Google::Apis::ToolresultsV1beta3::TestCase
1236
+ command.params['projectId'] = project_id unless project_id.nil?
1237
+ command.params['historyId'] = history_id unless history_id.nil?
1238
+ command.params['executionId'] = execution_id unless execution_id.nil?
1239
+ command.params['stepId'] = step_id unless step_id.nil?
1240
+ command.params['testCaseId'] = test_case_id unless test_case_id.nil?
1241
+ command.query['fields'] = fields unless fields.nil?
1242
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1243
+ execute_or_queue_command(command, &block)
1244
+ end
1245
+
1246
+ # Lists Test Cases attached to a Step. Experimental test cases API. Still in
1247
+ # active development. May return any of the following canonical error codes: -
1248
+ # PERMISSION_DENIED - if the user is not authorized to write to project -
1249
+ # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing
1250
+ # Step does not exist
1251
+ # @param [String] project_id
1252
+ # A Project id. Required.
1253
+ # @param [String] history_id
1254
+ # A History id. Required.
1255
+ # @param [String] execution_id
1256
+ # A Execution id Required.
1257
+ # @param [String] step_id
1258
+ # A Step id. Note: This step must include a TestExecutionStep. Required.
1259
+ # @param [Fixnum] page_size
1260
+ # The maximum number of TestCases to fetch. Default value: 100. The server will
1261
+ # use this default if the field is not set or has a value of 0. Optional.
1262
+ # @param [String] page_token
1263
+ # A continuation token to resume the query at the next item. Optional.
1264
+ # @param [String] fields
1265
+ # Selector specifying which fields to include in a partial response.
1266
+ # @param [String] quota_user
1267
+ # Available to use for quota purposes for server-side applications. Can be any
1268
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1269
+ # @param [Google::Apis::RequestOptions] options
1270
+ # Request-specific options
1271
+ #
1272
+ # @yield [result, err] Result & error if block supplied
1273
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListTestCasesResponse] parsed result object
1274
+ # @yieldparam err [StandardError] error object if request failed
1275
+ #
1276
+ # @return [Google::Apis::ToolresultsV1beta3::ListTestCasesResponse]
1277
+ #
1278
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1279
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1280
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1281
+ def list_project_history_execution_step_test_cases(project_id, history_id, execution_id, step_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1282
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases', options)
1283
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListTestCasesResponse::Representation
1284
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListTestCasesResponse
1285
+ command.params['projectId'] = project_id unless project_id.nil?
1286
+ command.params['historyId'] = history_id unless history_id.nil?
1287
+ command.params['executionId'] = execution_id unless execution_id.nil?
1288
+ command.params['stepId'] = step_id unless step_id.nil?
1289
+ command.query['pageSize'] = page_size unless page_size.nil?
1290
+ command.query['pageToken'] = page_token unless page_token.nil?
1291
+ command.query['fields'] = fields unless fields.nil?
1292
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1293
+ execute_or_queue_command(command, &block)
1294
+ end
1295
+
1296
+ # Lists thumbnails of images attached to a step. May return any of the following
1297
+ # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to
1298
+ # read from the project, or from any of the images - INVALID_ARGUMENT - if the
1299
+ # request is malformed - NOT_FOUND - if the step does not exist, or if any of
1300
+ # the images do not exist
1301
+ # @param [String] project_id
1302
+ # A Project id. Required.
1303
+ # @param [String] history_id
1304
+ # A History id. Required.
1305
+ # @param [String] execution_id
1306
+ # An Execution id. Required.
1307
+ # @param [String] step_id
1308
+ # A Step id. Required.
1309
+ # @param [Fixnum] page_size
1310
+ # The maximum number of thumbnails to fetch. Default value: 50. The server will
1311
+ # use this default if the field is not set or has a value of 0. Optional.
1312
+ # @param [String] page_token
1313
+ # A continuation token to resume the query at the next item. Optional.
1314
+ # @param [String] fields
1315
+ # Selector specifying which fields to include in a partial response.
1316
+ # @param [String] quota_user
1317
+ # Available to use for quota purposes for server-side applications. Can be any
1318
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1319
+ # @param [Google::Apis::RequestOptions] options
1320
+ # Request-specific options
1321
+ #
1322
+ # @yield [result, err] Result & error if block supplied
1323
+ # @yieldparam result [Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse] parsed result object
1324
+ # @yieldparam err [StandardError] error object if request failed
1325
+ #
1326
+ # @return [Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse]
1327
+ #
1328
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1329
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1330
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1331
+ def list_project_history_execution_step_thumbnails(project_id, history_id, execution_id, step_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1332
+ command = make_simple_command(:get, 'toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails', options)
1333
+ command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse::Representation
1334
+ command.response_class = Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse
1335
+ command.params['projectId'] = project_id unless project_id.nil?
1336
+ command.params['historyId'] = history_id unless history_id.nil?
1337
+ command.params['executionId'] = execution_id unless execution_id.nil?
1338
+ command.params['stepId'] = step_id unless step_id.nil?
1339
+ command.query['pageSize'] = page_size unless page_size.nil?
1340
+ command.query['pageToken'] = page_token unless page_token.nil?
1341
+ command.query['fields'] = fields unless fields.nil?
1342
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1343
+ execute_or_queue_command(command, &block)
1344
+ end
1345
+
1346
+ protected
1347
+
1348
+ def apply_command_defaults(command)
1349
+ command.query['key'] = key unless key.nil?
1350
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1351
+ end
1352
+ end
1353
+ end
1354
+ end
1355
+ end