Cloud Run V2 API - Class Google::Cloud::Run::V2::SourceUpload::Rest::Client (v0.32.0)

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

REST client for the SourceUpload service.

The Cloud Run Source Upload API allows you to upload source code to deploy Cloud Run resources.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the SourceUpload 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 SourceUpload clients
::Google::Cloud::Run::V2::SourceUpload::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the SourceUpload 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 SourceUpload REST client object.

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

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

#location_client

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

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

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#upload_source

def upload_source(request, options = nil) -> ::Google::Cloud::Run::V2::UploadSourceResponse
def upload_source(parent: nil, service: nil) -> ::Google::Cloud::Run::V2::UploadSourceResponse

Uploads a source archive to a Google Cloud Storage bucket through Cloud Run. The uploaded source object should be used for Cloud Run resource deployments. User is responsible for managing the lifecycle of the uploaded object. If uploading through the Cloud Run API to Cloud Storage is not desired, you can use the IAM Deny Policy to deny the run.locations.uploadSource permission for all principals.

Overloads 
def upload_source(request, options = nil) -> ::Google::Cloud::Run::V2::UploadSourceResponse
Pass arguments to upload_source via a request object, either of type UploadSourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::UploadSourceRequest, ::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 upload_source(parent: nil, service: nil) -> ::Google::Cloud::Run::V2::UploadSourceResponse
Pass arguments to upload_source 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 in which the source archive should be uploaded to, specified in the format projects/*/locations/*.
  • service (::String) — The name of Cloud Run Service upload source archive will be used for.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::SourceUpload::Rest::Client.new

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

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

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