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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/toolresults_v1beta3/service.rb

Overview

Cloud Tool Results API

API to publish and access results from developer tools.

Examples:

require 'google/apis/toolresults_v1beta3'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ToolResultsService

Returns a new instance of ToolResultsService.



45
46
47
48
49
50
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 45

def initialize
  super('https://toolresults.googleapis.com/', '',
        client_name: 'google-apis-toolresults_v1beta3',
        client_version: Google::Apis::ToolresultsV1beta3::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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 'lib/google/apis/toolresults_v1beta3/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



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

def quota_user
  @quota_user
end

Instance Method Details

#accessibility_project_history_execution_step_clusters(name, locale: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse

Lists accessibility clusters for a given 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 - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if the locale format is incorrect - NOT_FOUND - if the containing Step does not exist

Parameters:

  • name (String) —

    A full resource name of the step. For example, projects/my-project/histories/ bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required.

  • locale (String) (defaults to: nil) —

    The accepted format is the canonical Unicode format with hyphen as a delimiter. Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for details. Required.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



628
629
630
631
632
633
634
635
636
637
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 628

def accessibility_project_history_execution_step_clusters(name, locale: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/{+name}:accessibilityClusters', options)
  command.response_representation = Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse::Representation
  command.response_class = Google::Apis::ToolresultsV1beta3::ListStepAccessibilityClustersResponse
  command.params['name'] = name unless name.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) {|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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:post, 'toolresults/v1beta3/projects/{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?
  execute_or_queue_command(command, &block)
end

#create_project_history(project_id, history_object = nil, request_id: nil, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 158

def create_project_history(project_id, history_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 282

def create_project_history_execution(project_id, history_id, execution_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:post, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:post, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:post, 'toolresults/v1beta3/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_project_history(project_id, history_id, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 196

def get_project_history(project_id, history_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_project_history_execution(project_id, history_id, execution_id, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_project_history_execution(project_id, history_id, execution_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 453

def get_project_history_execution_cluster(project_id, history_id, execution_id, cluster_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 536

def get_project_history_execution_environment(project_id, history_id, execution_id, environment_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 715

def get_project_history_execution_step(project_id, history_id, execution_id, step_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_project_settings(project_id, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



74
75
76
77
78
79
80
81
82
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 74

def get_project_settings(project_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  execute_or_queue_command(command, &block)
end

#initialize_project_settings(project_id, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



121
122
123
124
125
126
127
128
129
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 121

def initialize_project_settings(project_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  execute_or_queue_command(command, &block)
end

#list_project_history_execution_clusters(project_id, history_id, execution_id, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 495

def list_project_history_execution_clusters(project_id, history_id, execution_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 367

def list_project_history_executions(project_id, history_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:patch, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:patch, 'toolresults/v1beta3/projects/{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?
  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, 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/google/apis/toolresults_v1beta3/service.rb', line 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)
  command = make_simple_command(:post, 'toolresults/v1beta3/projects/{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?
  execute_or_queue_command(command, &block)
end