Module: Google::Cloud::Build

Defined in:
lib/google/cloud/build.rb,
lib/google/cloud/build/version.rb

Constant Summary collapse

VERSION = 
"1.6.2"

Class Method Summary collapse

Class Method Details

.cloud_build(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for CloudBuild.

By default, this returns an instance of Google::Cloud::Build::V1::CloudBuild::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the CloudBuild service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the CloudBuild service. You can determine whether the method will succeed by calling cloud_build_available?.

About CloudBuild

Creates and manages builds on Google Cloud Platform.

The main concept used by this API is a Build, which describes the location of the source to build, how to build the source, and where to store the built artifacts, if any.

A user can list previously-requested builds or get builds by their ID to determine the status of the build.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/google/cloud/build.rb', line 82

def self.cloud_build version: :v1, transport: :grpc, &block
  require "google/cloud/build/#{version.to_s.downcase}"

  package_name = Google::Cloud::Build
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Build.const_get(package_name).const_get(:CloudBuild)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.cloud_build_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the CloudBuild service is supported by the current client. If true, you can retrieve a client object by calling cloud_build. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the CloudBuild service, or if the versioned client gem needs an update to support the CloudBuild service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/build.rb', line 106

def self.cloud_build_available? version: :v1, transport: :grpc
  require "google/cloud/build/#{version.to_s.downcase}"
  package_name = Google::Cloud::Build
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Build.const_get package_name
  return false unless service_module.const_defined? :CloudBuild
  service_module = service_module.const_get :CloudBuild
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.configure {|::Google::Cloud.configure.build| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-build library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



153
154
155
156
157
 
# File 'lib/google/cloud/build.rb', line 153

def self.configure
  yield ::Google::Cloud.configure.build if block_given?

  ::Google::Cloud.configure.build
end