Class: Google::Apis::CloudbuildV1alpha2::CloudBuildService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudbuild_v1alpha2/service.rb

Overview

Cloud Build API

Creates and manages builds on Google Cloud Platform.

Examples:

require 'google/apis/cloudbuild_v1alpha2'

Cloudbuild = Google::Apis::CloudbuildV1alpha2 # Alias the module
service = Cloudbuild::CloudBuildService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initialize ⇒ CloudBuildService

Returns a new instance of CloudBuildService.



45
46
47
48
 
# File 'generated/google/apis/cloudbuild_v1alpha2/service.rb', line 45

def initialize
  super('https://cloudbuild.googleapis.com/', '')
  @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 'generated/google/apis/cloudbuild_v1alpha2/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 'generated/google/apis/cloudbuild_v1alpha2/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#create_project_worker_pool(parent, worker_pool_object = nil, worker_pool_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudbuildV1alpha2::WorkerPool

Creates a WorkerPool to run the builds, and returns the new worker pool.

Parameters:

  • parent (String) —

    Required. The parent resource where this book will be created. Format: projects/project

  • worker_pool_object (Google::Apis::CloudbuildV1alpha2::WorkerPool) (defaults to: nil)
  • worker_pool_id (String) (defaults to: nil) —

    Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.

  • 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:



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

def create_project_worker_pool(parent, worker_pool_object = nil, worker_pool_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/workerPools', options)
  command.request_representation = Google::Apis::CloudbuildV1alpha2::WorkerPool::Representation
  command.request_object = worker_pool_object
  command.response_representation = Google::Apis::CloudbuildV1alpha2::WorkerPool::Representation
  command.response_class = Google::Apis::CloudbuildV1alpha2::WorkerPool
  command.params['parent'] = parent unless parent.nil?
  command.query['workerPoolId'] = worker_pool_id unless worker_pool_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

#delete_project_worker_pool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudbuildV1alpha2::Empty

Deletes a WorkerPool.

Parameters:

  • name (String) —

    Required. The name of the WorkerPool to delete. Format: projects/project/workerPools/workerPool

  • 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:



112
113
114
115
116
117
118
119
120
 
# File 'generated/google/apis/cloudbuild_v1alpha2/service.rb', line 112

def delete_project_worker_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::CloudbuildV1alpha2::Empty::Representation
  command.response_class = Google::Apis::CloudbuildV1alpha2::Empty
  command.params['name'] = name unless name.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_worker_pool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudbuildV1alpha2::WorkerPool

Returns details of a WorkerPool.

Parameters:

  • name (String) —

    Required. The name of the WorkerPool to retrieve. Format: projects/project/workerPools/workerPool

  • 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:



143
144
145
146
147
148
149
150
151
 
# File 'generated/google/apis/cloudbuild_v1alpha2/service.rb', line 143

def get_project_worker_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::CloudbuildV1alpha2::WorkerPool::Representation
  command.response_class = Google::Apis::CloudbuildV1alpha2::WorkerPool
  command.params['name'] = name unless name.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_worker_pools(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudbuildV1alpha2::ListWorkerPoolsResponse

Lists WorkerPools by project.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of WorkerPools. Format: projects/project

  • 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:



174
175
176
177
178
179
180
181
182
 
# File 'generated/google/apis/cloudbuild_v1alpha2/service.rb', line 174

def list_project_worker_pools(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/workerPools', options)
  command.response_representation = Google::Apis::CloudbuildV1alpha2::ListWorkerPoolsResponse::Representation
  command.response_class = Google::Apis::CloudbuildV1alpha2::ListWorkerPoolsResponse
  command.params['parent'] = parent unless parent.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_worker_pool(name, worker_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudbuildV1alpha2::WorkerPool

Updates a WorkerPool.

Parameters:

  • name (String) —

    Output only. The resource name of the WorkerPool. Format of the name is projects/project_id/workerPools/worker_pool_id`, where the value ofworker_pool_id` is provided in the CreateWorkerPool request.

  • worker_pool_object (Google::Apis::CloudbuildV1alpha2::WorkerPool) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    A mask specifying which fields in WorkerPool should be updated.

  • 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:



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'generated/google/apis/cloudbuild_v1alpha2/service.rb', line 210

def patch_project_worker_pool(name, worker_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::CloudbuildV1alpha2::WorkerPool::Representation
  command.request_object = worker_pool_object
  command.response_representation = Google::Apis::CloudbuildV1alpha2::WorkerPool::Representation
  command.response_class = Google::Apis::CloudbuildV1alpha2::WorkerPool
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end