Cloud Functions V2 API - Class Google::Cloud::Functions::V2::FunctionService::Client (v0.8.0)

Reference documentation and code samples for the Cloud Functions V2 API class Google::Cloud::Functions::V2::FunctionService::Client.

Client for the FunctionService service.

Google Cloud Functions is used to deploy functions that are executed by Google in response to various events. Data connected with that event is passed to a function as the input data.

A function is a resource which describes a function that should be executed and how it is triggered.

Inherits

Object

Includes

Google::Cloud::Functions::V2::FunctionService::Paths

Methods

.configure

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

Configure the FunctionService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#configure

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

Configure the FunctionService 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

config (Client::Configuration)

Returns

(Client::Configuration)

#create_function

def create_function(request, options = nil) -> ::Gapic::Operation
def create_function(parent: nil, function: nil, function_id: nil) -> ::Gapic::Operation

Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return ALREADY_EXISTS error.

Overloads

def create_function(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_function via a request object, either of type CreateFunctionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Functions::V2::CreateFunctionRequest, ::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 create_function(parent: nil, function: nil, function_id: nil) -> ::Gapic::Operation

Pass arguments to create_function 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 function should be created, specified in the format projects/*/locations/*
function (::Google::Cloud::Functions::V2::Function, ::Hash) — Required. Function to be created.
function_id (::String) — The ID to use for the function, which will become the final component of the function's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/functions/v2"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_function

def delete_function(request, options = nil) -> ::Gapic::Operation
def delete_function(name: nil) -> ::Gapic::Operation

Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.

Overloads

def delete_function(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_function via a request object, either of type DeleteFunctionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Functions::V2::DeleteFunctionRequest, ::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 delete_function(name: nil) -> ::Gapic::Operation

Pass arguments to delete_function 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).

Parameter

name (::String) — Required. The name of the function which should be deleted.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/functions/v2"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#generate_download_url

def generate_download_url(request, options = nil) -> ::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse
def generate_download_url(name: nil) -> ::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse

Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls

Overloads

def generate_download_url(request, options = nil) -> ::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse

Pass arguments to generate_download_url via a request object, either of type GenerateDownloadUrlRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Functions::V2::GenerateDownloadUrlRequest, ::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 generate_download_url(name: nil) -> ::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse

Pass arguments to generate_download_url 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).

Parameter

name (::String) — Required. The name of function for which source code Google Cloud Storage signed URL should be generated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/functions/v2"

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

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

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

# The returned object is of type Google::Cloud::Functions::V2::GenerateDownloadUrlResponse.
p result

#generate_upload_url

def generate_upload_url(request, options = nil) -> ::Google::Cloud::Functions::V2::GenerateUploadUrlResponse
def generate_upload_url(parent: nil, kms_key_name: nil, environment: nil) -> ::Google::Cloud::Functions::V2::GenerateUploadUrlResponse

Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code.

When uploading source code to the generated signed URL, please follow these restrictions:

Source file type should be a zip file.
No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL.

When making a HTTP PUT request, specify this header:

content-type: application/zip

Do not specify this header:

Authorization: Bearer YOUR_TOKEN

Overloads

def generate_upload_url(request, options = nil) -> ::Google::Cloud::Functions::V2::GenerateUploadUrlResponse

Pass arguments to generate_upload_url via a request object, either of type GenerateUploadUrlRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Functions::V2::GenerateUploadUrlRequest, ::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 generate_upload_url(parent: nil, kms_key_name: nil, environment: nil) -> ::Google::Cloud::Functions::V2::GenerateUploadUrlResponse

Pass arguments to generate_upload_url 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 Google Cloud Storage signed URL should be generated, specified in the format projects/*/locations/*.
kms_key_name (::String) — [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).
environment (::Google::Cloud::Functions::V2::Environment) — The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Functions::V2::GenerateUploadUrlResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Functions::V2::GenerateUploadUrlResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/functions/v2"

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

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

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

# The returned object is of type Google::Cloud::Functions::V2::GenerateUploadUrlResponse.
p result

#get_function

def get_function(request, options = nil) -> ::Google::Cloud::Functions::V2::Function
def get_function(name: nil, revision: nil) -> ::Google::Cloud::Functions::V2::Function

Returns a function with the given name from the requested project.

Overloads

def get_function(request, options = nil) -> ::Google::Cloud::Functions::V2::Function

Pass arguments to get_function via a request object, either of type GetFunctionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Functions::V2::GetFunctionRequest, ::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 get_function(name: nil, revision: nil) -> ::Google::Cloud::Functions::V2::Function

Pass arguments to get_function 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

name (::String) — Required. The name of the function which details should be obtained.
revision (::String) — Optional. The version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Functions::V2::Function)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Functions::V2::Function)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/functions/v2"

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

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

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

# The returned object is of type Google::Cloud::Functions::V2::Function.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

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

Returns

(Google::Iam::V1::IAMPolicy::Client)

#initialize

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

Create a new FunctionService client object.

Yields

(config) — Configure the FunctionService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Functions::V2::FunctionService::Client.new

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

#list_functions

def list_functions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Functions::V2::Function>
def list_functions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Functions::V2::Function>

Returns a list of functions that belong to the requested project.

Overloads

def list_functions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Functions::V2::Function>

Pass arguments to list_functions via a request object, either of type ListFunctionsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Functions::V2::ListFunctionsRequest, ::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 list_functions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Functions::V2::Function>

Pass arguments to list_functions 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 from which the function should be listed, specified in the format projects/*/locations/* If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.
page_size (::Integer) — Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters.
page_token (::String) — The value returned by the last ListFunctionsResponse; indicates that this is a continuation of a prior ListFunctions call, and that the system should return the next page of data.
filter (::String) — The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
order_by (::String) — The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Functions::V2::Function>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Functions::V2::Function>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/functions/v2"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Functions::V2::Function.
  p item
end

#list_runtimes

def list_runtimes(request, options = nil) -> ::Google::Cloud::Functions::V2::ListRuntimesResponse
def list_runtimes(parent: nil, filter: nil) -> ::Google::Cloud::Functions::V2::ListRuntimesResponse

Returns a list of runtimes that are supported for the requested project.

Overloads

def list_runtimes(request, options = nil) -> ::Google::Cloud::Functions::V2::ListRuntimesResponse

Pass arguments to list_runtimes via a request object, either of type ListRuntimesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Functions::V2::ListRuntimesRequest, ::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 list_runtimes(parent: nil, filter: nil) -> ::Google::Cloud::Functions::V2::ListRuntimesResponse

Pass arguments to list_runtimes 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 from which the runtimes should be listed, specified in the format projects/*/locations/*
filter (::String) — The filter for Runtimes that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Functions::V2::ListRuntimesResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Functions::V2::ListRuntimesResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/functions/v2"

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

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

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

# The returned object is of type Google::Cloud::Functions::V2::ListRuntimesResponse.
p result

#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)

#operations_client

def operations_client() -> ::Google::Cloud::Functions::V2::FunctionService::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::Functions::V2::FunctionService::Operations)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_function

def update_function(request, options = nil) -> ::Gapic::Operation
def update_function(function: nil, update_mask: nil) -> ::Gapic::Operation

Updates existing function.

Overloads

def update_function(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_function via a request object, either of type UpdateFunctionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Functions::V2::UpdateFunctionRequest, ::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 update_function(function: nil, update_mask: nil) -> ::Gapic::Operation

Pass arguments to update_function 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

function (::Google::Cloud::Functions::V2::Function, ::Hash) — Required. New version of the function.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated. If no field mask is provided, all fields will be updated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/functions/v2"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end