class Google::Apis::TestingV1::TestingService

Cloud Testing API

Allows developers to run automated tests for their mobile applications on

Google infrastructure.

@example

require 'google/apis/testing_v1'

Testing = Google::Apis::TestingV1 # Alias the module
service = Testing::TestingService.new

@see developers.google.com/cloud-test-lab/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/testing_v1/service.rb, line 46
def initialize
  super('https://testing.googleapis.com/', '',
        client_name: 'google-apis-testing_v1',
        client_version: Google::Apis::TestingV1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

cancel_project_test_matrix(project_id, test_matrix_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect. 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 Test Matrix does not exist @param [String] project_id

Cloud project that owns the test.

@param [String] test_matrix_id

Test matrix that will be canceled.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TestingV1::CancelTestMatrixResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TestingV1::CancelTestMatrixResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/testing_v1/service.rb, line 110
def cancel_project_test_matrix(project_id, test_matrix_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel', options)
  command.response_representation = Google::Apis::TestingV1::CancelTestMatrixResponse::Representation
  command.response_class = Google::Apis::TestingV1::CancelTestMatrixResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['testMatrixId'] = test_matrix_id unless test_matrix_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_test_matrix(project_id, test_matrix_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. A test matrix is limited to use at most 2000 devices in parallel. 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 or if the matrix tries to use too many simultaneous devices. @param [String] project_id

The GCE project under which this job will run.

@param [Google::Apis::TestingV1::TestMatrix] test_matrix_object @param [String] request_id

A string id used to detect duplicated requests. Ids are automatically scoped
to a project, so users should ensure the ID is unique per-project. A UUID is
recommended. Optional, but strongly recommended.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TestingV1::TestMatrix] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TestingV1::TestMatrix]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/testing_v1/service.rb, line 151
def create_project_test_matrix(project_id, test_matrix_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/testMatrices', options)
  command.request_representation = Google::Apis::TestingV1::TestMatrix::Representation
  command.request_object = test_matrix_object
  command.response_representation = Google::Apis::TestingV1::TestMatrix::Representation
  command.response_class = Google::Apis::TestingV1::TestMatrix
  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
get_application_detail_service_apk_details(file_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the details of an Android application APK. @param [Google::Apis::TestingV1::FileReference] file_reference_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TestingV1::GetApkDetailsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TestingV1::GetApkDetailsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/testing_v1/service.rb, line 72
def get_application_detail_service_apk_details(file_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/applicationDetailService/getApkDetails', options)
  command.request_representation = Google::Apis::TestingV1::FileReference::Representation
  command.request_object = file_reference_object
  command.response_representation = Google::Apis::TestingV1::GetApkDetailsResponse::Representation
  command.response_class = Google::Apis::TestingV1::GetApkDetailsResponse
  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_test_matrix(project_id, test_matrix_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Checks the status of a test matrix. 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 Test Matrix does not exist @param [String] project_id

Cloud project that owns the test matrix.

@param [String] test_matrix_id

Unique test matrix id which was assigned by the service.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TestingV1::TestMatrix] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TestingV1::TestMatrix]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/testing_v1/service.rb, line 189
def get_project_test_matrix(project_id, test_matrix_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectId}/testMatrices/{testMatrixId}', options)
  command.response_representation = Google::Apis::TestingV1::TestMatrix::Representation
  command.response_class = Google::Apis::TestingV1::TestMatrix
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['testMatrixId'] = test_matrix_id unless test_matrix_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_test_environment_catalog(environment_type, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the catalog of supported test environments. May return any of the following canonical error codes: - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the environment type does not exist - INTERNAL - if an internal error occurred @param [String] environment_type

Required. The type of environment that should be listed.

@param [String] project_id

For authorization, the cloud project requesting the TestEnvironmentCatalog.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TestingV1::TestEnvironmentCatalog] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::TestingV1::TestEnvironmentCatalog]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/testing_v1/service.rb, line 225
def get_test_environment_catalog(environment_type, project_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/testEnvironmentCatalog/{environmentType}', options)
  command.response_representation = Google::Apis::TestingV1::TestEnvironmentCatalog::Representation
  command.response_class = Google::Apis::TestingV1::TestEnvironmentCatalog
  command.params['environmentType'] = environment_type unless environment_type.nil?
  command.query['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

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/testing_v1/service.rb, line 238
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end