Cloud Run V2 API - Class Google::Cloud::Run::V2::Builds::Client (v0.18.0)

Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::Builds::Client.

Client for the Builds service.

Cloud Run Build Control Plane API

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Builds Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Builds clients
::Google::Cloud::Run::V2::Builds::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Builds Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new Builds client object.

Yields
  • (config) — Configure the Builds client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Run::V2::Builds::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Run::V2::Builds::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#submit_build

def submit_build(request, options = nil) -> ::Google::Cloud::Run::V2::SubmitBuildResponse
def submit_build(parent: nil, storage_source: nil, image_uri: nil, buildpack_build: nil, docker_build: nil, service_account: nil, worker_pool: nil, tags: nil) -> ::Google::Cloud::Run::V2::SubmitBuildResponse

Submits a build in a given project.

Overloads 
def submit_build(request, options = nil) -> ::Google::Cloud::Run::V2::SubmitBuildResponse
Pass arguments to submit_build via a request object, either of type SubmitBuildRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::SubmitBuildRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def submit_build(parent: nil, storage_source: nil, image_uri: nil, buildpack_build: nil, docker_build: nil, service_account: nil, worker_pool: nil, tags: nil) -> ::Google::Cloud::Run::V2::SubmitBuildResponse
Pass arguments to submit_build via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used. Format: projects/{project}/locations/{location}
  • storage_source (::Google::Cloud::Run::V2::StorageSource, ::Hash) — Required. Source for the build.
  • image_uri (::String) — Required. Artifact Registry URI to store the built image.
  • buildpack_build (::Google::Cloud::Run::V2::SubmitBuildRequest::BuildpacksBuild, ::Hash) — Build the source using Buildpacks.
  • docker_build (::Google::Cloud::Run::V2::SubmitBuildRequest::DockerBuild, ::Hash) — Build the source using Docker. This means the source has a Dockerfile.
  • service_account (::String) — Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.
  • worker_pool (::String) — Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.
  • tags (::Array<::String>) — Optional. Additional tags to annotate the build.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/run/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Run::V2::Builds::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Run::V2::SubmitBuildRequest.new

# Call the submit_build method.
result = client.submit_build request

# The returned object is of type Google::Cloud::Run::V2::SubmitBuildResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)