Cloud Build API - Module Google::Cloud::Build (v1.6.1)

Reference documentation and code samples for the Cloud Build API module Google::Cloud::Build.

  def 
  
 self 
 . 
 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 Build.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.

  def 
  
 self 
 . 
 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 Build.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.

  def 
  
 self 
 . 
 configure 
 () 
  
 - 
>  
 :: 
 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.

value: "1.6.1"