google-apis-testing_v1 0.1.0

data/lib/google/apis/testing_v1/service.rb

@@ -0,0 +1,245 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module TestingV1
+      # 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 https://developers.google.com/cloud-test-lab/
+      class TestingService < Google::Apis::Core::BaseService
+        # @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.
+        attr_accessor :key
+
+        # @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.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://testing.googleapis.com/', '',
+                client_name: 'google-apis-testing_v1',
+                client_version: Google::Apis::TestingV1::GEM_VERSION)
+          @batch_path = 'batch'
+        end
+        
+        # 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
+        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
+        
+        # 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
+        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
+        
+        # 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
+        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
+        
+        # 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
+        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
+        
+        # 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
+        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
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: google-apis-testing_v1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Google LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-apis-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: This is the simple REST client for Cloud Testing API V1. Simple REST
+  clients are Ruby client libraries that provide access to Google services via their
+  HTTP REST API endpoints. These libraries are generated and updated automatically
+  based on the discovery documents published by the service, and they handle most
+  concerns such as authentication, pagination, retry, timeouts, and logging. You can
+  use this client to access the Cloud Testing API, but note that some services may
+  provide a separate modern client that is easier to use.
+email: googleapis-packages@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.md
+- OVERVIEW.md
+- lib/google-apis-testing_v1.rb
+- lib/google/apis/testing_v1.rb
+- lib/google/apis/testing_v1/classes.rb
+- lib/google/apis/testing_v1/gem_version.rb
+- lib/google/apis/testing_v1/representations.rb
+- lib/google/apis/testing_v1/service.rb
+homepage: https://github.com/google/google-api-ruby-client
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
+  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-testing_v1/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-testing_v1/v0.1.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-testing_v1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Simple REST client for Cloud Testing API V1
+test_files: []