Class: Google::Apis::ToolresultsV1beta3::ToolResultsService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/toolresults_v1beta3/service.rb

Overview

Cloud Tool Results API

Reads and publishes results from Firebase Test Lab.

Examples:

require 'google/apis/toolresults_v1beta3'

Toolresults = Google::Apis::ToolresultsV1beta3 # Alias the module
service = Toolresults::ToolResultsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeToolResultsService

Returns a new instance of ToolResultsService.


49
50
51
52
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'toolresults/v1beta3/projects/')
  @batch_path = 'batch/toolresults/v1beta3'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


38
39
40
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.


43
44
45
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


47
48
49
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesResponse

Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database). May return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist

Parameters:

  • project_id (String)

    The cloud project

  • history_id (String)

    A tool results history ID.

  • execution_id (String)

    A tool results execution ID.

  • step_id (String)

    A tool results step ID.

  • sample_series_id (String)

    A sample series id

  • batch_create_perf_samples_request_object (Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1234

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesRequest::Representation
  command.request_object = batch_create_perf_samples_request_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::BatchCreatePerfSamplesResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.params['sampleSeriesId'] = sample_series_id unless sample_series_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_project_history(project_id, history_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::History

Creates a History. The returned History will have the id set. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_object (Google::Apis::ToolresultsV1beta3::History) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 175

def create_project_history(project_id, history_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{projectId}/histories', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::History::Representation
  command.request_object = history_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::History::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::History
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_project_history_execution(project_id, history_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::Execution

Creates an Execution. The returned Execution will have the id set. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_object (Google::Apis::ToolresultsV1beta3::Execution) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 322

def create_project_history_execution(project_id, history_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{projectId}/histories/{historyId}/executions', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
  command.request_object = execution_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::Execution
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_project_history_execution_step(project_id, history_id, execution_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::Step

Creates a Step. The returned Step will have the id set. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist

Parameters:

  • project_id (String)

    Required. A Project id.

  • history_id (String)

    Required. A History id.

  • execution_id (String)

    Required. An Execution id.

  • step_object (Google::Apis::ToolresultsV1beta3::Step) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 719

def create_project_history_execution_step(project_id, history_id, execution_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{projectId}/histories/{historyId}/executions/{executionId}/steps', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
  command.request_object = step_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::Step
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::PerfMetricsSummary

Creates a PerfMetricsSummary resource. Returns the existing one if it has already been created. May return any of the following error code(s): - NOT_FOUND - The containing Step does not exist

Parameters:

  • project_id (String)

    The cloud project

  • history_id (String)

    A tool results history ID.

  • execution_id (String)

    A tool results execution ID.

  • step_id (String)

    A tool results step ID.

  • perf_metrics_summary_object (Google::Apis::ToolresultsV1beta3::PerfMetricsSummary) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1035

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation
  command.request_object = perf_metrics_summary_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::PerfSampleSeries

Creates a PerfSampleSeries. May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist

Parameters:

  • project_id (String)

    The cloud project

  • history_id (String)

    A tool results history ID.

  • execution_id (String)

    A tool results execution ID.

  • step_id (String)

    A tool results step ID.

  • perf_sample_series_object (Google::Apis::ToolresultsV1beta3::PerfSampleSeries) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1083

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation
  command.request_object = perf_sample_series_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::PerfSampleSeries
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_history(project_id, history_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::History

Gets a History. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


219
220
221
222
223
224
225
226
227
228
229
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 219

def get_project_history(project_id, history_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::History::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::History
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_history_execution(project_id, history_id, execution_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::Execution

Gets an Execution. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    An Execution id. Required.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


370
371
372
373
374
375
376
377
378
379
380
381
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 370

def get_project_history_execution(project_id, history_id, execution_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::Execution
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_history_execution_cluster(project_id, history_id, execution_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ScreenshotCluster

Retrieves a single screenshot cluster by its ID

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    An Execution id. Required.

  • cluster_id (String)

    A Cluster id Required.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


522
523
524
525
526
527
528
529
530
531
532
533
534
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 522

def get_project_history_execution_cluster(project_id, history_id, execution_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ScreenshotCluster::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ScreenshotCluster
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_history_execution_environment(project_id, history_id, execution_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::Environment

Gets an Environment. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Environment does not exist

Parameters:

  • project_id (String)

    Required. A Project id.

  • history_id (String)

    Required. A History id.

  • execution_id (String)

    Required. An Execution id.

  • environment_id (String)

    Required. An Environment id.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


616
617
618
619
620
621
622
623
624
625
626
627
628
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 616

def get_project_history_execution_environment(project_id, history_id, execution_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::Environment::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::Environment
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['environmentId'] = environment_id unless environment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_history_execution_step(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::Step

Gets a Step. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    A Execution id. Required.

  • step_id (String)

    A Step id. Required.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


771
772
773
774
775
776
777
778
779
780
781
782
783
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 771

def get_project_history_execution_step(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::Step
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_history_execution_step_perf_metrics_summary(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::PerfMetricsSummary

Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist

Parameters:

  • project_id (String)

    The cloud project

  • history_id (String)

    A tool results history ID.

  • execution_id (String)

    A tool results execution ID.

  • step_id (String)

    A tool results step ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


815
816
817
818
819
820
821
822
823
824
825
826
827
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 815

def get_project_history_execution_step_perf_metrics_summary(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::PerfMetricsSummary
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, sample_series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::PerfSampleSeries

Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist

Parameters:

  • project_id (String)

    The cloud project

  • history_id (String)

    A tool results history ID.

  • execution_id (String)

    A tool results execution ID.

  • step_id (String)

    A tool results step ID.

  • sample_series_id (String)

    A sample series id

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1131

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::PerfSampleSeries::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::PerfSampleSeries
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.params['sampleSeriesId'] = sample_series_id unless sample_series_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_history_execution_step_test_case(project_id, history_id, execution_id, step_id, test_case_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::TestCase

Gets details of a Test Case for a Step. Experimental test cases API. Still in active development. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Test Case does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    A Execution id Required.

  • step_id (String)

    A Step id. Note: This step must include a TestExecutionStep. Required.

  • test_case_id (String)

    A Test Case id. Required.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1351

def get_project_history_execution_step_test_case(project_id, history_id, execution_id, step_id, test_case_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::TestCase::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::TestCase
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.params['testCaseId'] = test_case_id unless test_case_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_settings(project_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ProjectSettings

Gets the Tool Results settings for a project. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read from project

Parameters:

  • project_id (String)

    A Project id. Required.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


79
80
81
82
83
84
85
86
87
88
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 79

def get_project_settings(project_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/settings', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ProjectSettings::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ProjectSettings
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#initialize_project_settings(project_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ProjectSettings

Creates resources for settings which have not yet been set. Currently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days. The bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/ editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details. If there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created. May return any canonical error codes, including the following:

  • PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage

Parameters:

  • project_id (String)

    A Project id. Required.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


131
132
133
134
135
136
137
138
139
140
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 131

def initialize_project_settings(project_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{projectId}:initializeSettings', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ProjectSettings::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ProjectSettings
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_project_histories(project_id, filter_by_name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListHistoriesResponse

Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • filter_by_name (String) (defaults to: nil)

    If set, only return histories with the given name. Optional.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional.

  • page_token (String) (defaults to: nil)

    A continuation token to resume the query at the next item. Optional.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 272

def list_project_histories(project_id, filter_by_name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListHistoriesResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListHistoriesResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['filterByName'] = filter_by_name unless filter_by_name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_project_history_execution_clusters(project_id, history_id, execution_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse

Lists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores.

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    An Execution id. Required.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


571
572
573
574
575
576
577
578
579
580
581
582
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 571

def list_project_history_execution_clusters(project_id, history_id, execution_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/clusters', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListScreenshotClustersResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_project_history_execution_environments(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse

Lists Environments for a given Execution. The Environments are sorted by display name. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Execution does not exist

Parameters:

  • project_id (String)

    Required. A Project id.

  • history_id (String)

    Required. A History id.

  • execution_id (String)

    Required. An Execution id.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0.

  • page_token (String) (defaults to: nil)

    A continuation token to resume the query at the next item.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


667
668
669
670
671
672
673
674
675
676
677
678
679
680
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 667

def list_project_history_execution_environments(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/environments', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListEnvironmentsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, filter: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse

Lists PerfSampleSeries for a given Step. The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids. May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist

Parameters:

  • project_id (String)

    The cloud project

  • history_id (String)

    A tool results history ID.

  • execution_id (String)

    A tool results execution ID.

  • step_id (String)

    A tool results step ID.

  • filter (Array<String>, String) (defaults to: nil)

    Specify one or more PerfMetricType values such as CPU to filter the result

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1181

def list_project_history_execution_step_perf_sample_series(project_id, history_id, execution_id, step_id, filter: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListPerfSampleSeriesResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse

Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist

Parameters:

  • project_id (String)

    The cloud project

  • history_id (String)

    A tool results history ID.

  • execution_id (String)

    A tool results execution ID.

  • step_id (String)

    A tool results step ID.

  • sample_series_id (String)

    A sample series id

  • page_size (Fixnum) (defaults to: nil)

    The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000

  • page_token (String) (defaults to: nil)

    Optional, the next_page_token returned in the previous response

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1294

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListPerfSamplesResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.params['sampleSeriesId'] = sample_series_id unless sample_series_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListTestCasesResponse

Lists Test Cases attached to a Step. Experimental test cases API. Still in active development. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Step does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    A Execution id Required.

  • step_id (String)

    A Step id. Note: This step must include a TestExecutionStep. Required.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of TestCases to fetch. Default value: 100. The server will use this default if the field is not set or has a value of 0. Optional.

  • page_token (String) (defaults to: nil)

    A continuation token to resume the query at the next item. Optional.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1411

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListTestCasesResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListTestCasesResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse

Lists thumbnails of images attached to a step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    An Execution id. Required.

  • step_id (String)

    A Step id. Required.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of thumbnails to fetch. Default value: 50. The server will use this default if the field is not set or has a value of 0. Optional.

  • page_token (String) (defaults to: nil)

    A continuation token to resume the query at the next item. Optional.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 1471

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListStepThumbnailsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_project_history_execution_steps(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListStepsResponse

Lists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    A Execution id. Required.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Steps to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional.

  • page_token (String) (defaults to: nil)

    A continuation token to resume the query at the next item. Optional.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


874
875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 874

def list_project_history_execution_steps(project_id, history_id, execution_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions/{executionId}/steps', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepsResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListStepsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_project_history_executions(project_id, history_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListExecutionsResponse

Lists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Executions to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional.

  • page_token (String) (defaults to: nil)

    A continuation token to resume the query at the next item. Optional.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 424

def list_project_history_executions(project_id, history_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{projectId}/histories/{historyId}/executions', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListExecutionsResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListExecutionsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_history_execution(project_id, history_id, execution_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::Execution

Updates an existing Execution with the supplied partial entity. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    Required.

  • execution_id (String)

    Required.

  • execution_object (Google::Apis::ToolresultsV1beta3::Execution) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 474

def patch_project_history_execution(project_id, history_id, execution_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, '{projectId}/histories/{historyId}/executions/{executionId}', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
  command.request_object = execution_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::Execution::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::Execution
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_history_execution_step(project_id, history_id, execution_id, step_id, step_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::Step

Updates an existing Step with the supplied partial entity. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    A Execution id. Required.

  • step_id (String)

    A Step id. Required.

  • step_object (Google::Apis::ToolresultsV1beta3::Step) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 932

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
  command.request_object = step_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::Step
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::Step

Publish xml files to an existing Step. May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist

Parameters:

  • project_id (String)

    A Project id. Required.

  • history_id (String)

    A History id. Required.

  • execution_id (String)

    A Execution id. Required.

  • step_id (String)

    A Step id. Note: This step must include a TestExecutionStep. Required.

  • publish_xunit_xml_files_request_object (Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
# File 'generated/google/apis/toolresults_v1beta3/service.rb', line 987

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, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles', options)
  command.request_representation = Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest::Representation
  command.request_object = publish_xunit_xml_files_request_object
  command.response_representation = Google::Apis::ToolresultsV1beta3::Step::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::Step
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['historyId'] = history_id unless history_id.nil?
  command.params['executionId'] = execution_id unless execution_id.nil?
  command.params['stepId'] = step_id unless step_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end