Class: Google::Cloud::Run::V2::Builds::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/run/v2/builds/client.rb

Overview

Client for the Builds service.

Cloud Run Build Control Plane API

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#worker_pool_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Builds client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the Builds client.

Yield Parameters:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/google/cloud/run/v2/builds/client.rb', line 125

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/run/v2/build_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @builds_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Run::V2::Builds::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @builds_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @builds_stub.endpoint
    config.universe_domain = @builds_stub.universe_domain
    config.logger = @builds_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


189
190
191
 
# File 'lib/google/cloud/run/v2/builds/client.rb', line 189

def location_client
  @location_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Builds Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Builds clients
::Google::Cloud::Run::V2::Builds::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/google/cloud/run/v2/builds/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Run", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



95
96
97
98
 
# File 'lib/google/cloud/run/v2/builds/client.rb', line 95

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


196
197
198
 
# File 'lib/google/cloud/run/v2/builds/client.rb', line 196

def logger
  @builds_stub.logger
end

#submit_build(request, options = nil) ⇒ ::Google::Cloud::Run::V2::SubmitBuildResponse #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. Source for the build.

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

      Required. Artifact Registry URI to store the built image.

    • buildpack_build (::Google::Cloud::Run::V2::SubmitBuildRequest::BuildpacksBuild, ::Hash) (defaults to: nil) —

      Build the source using Buildpacks.

    • docker_build (::Google::Cloud::Run::V2::SubmitBuildRequest::DockerBuild, ::Hash) (defaults to: nil) —

      Build the source using Docker. This means the source has a Dockerfile.

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

      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) (defaults to: nil) —

      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>) (defaults to: nil) —

      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.



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/google/cloud/run/v2/builds/client.rb', line 269

def submit_build request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Run::V2::SubmitBuildRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.submit_build.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Run::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.submit_build.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.submit_build.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @builds_stub.call_rpc :submit_build, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


105
106
107
 
# File 'lib/google/cloud/run/v2/builds/client.rb', line 105

def universe_domain
  @builds_stub.universe_domain
end