Cloud Functions V1 API - Class Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client (v0.11.0)

Reference documentation and code samples for the Cloud Functions V1 API class Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.

REST client for the CloudFunctionsService service.

A service that application uses to manipulate triggers and functions.

Inherits

  • Object

Includes

Methods

.configure

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

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

#call_function

def call_function(request, options = nil) -> ::Google::Cloud::Functions::V1::CallFunctionResponse
def call_function(name: nil, data: nil) -> ::Google::Cloud::Functions::V1::CallFunctionResponse

Synchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits, refer to Rate Limits.

Overloads 
def call_function(request, options = nil) -> ::Google::Cloud::Functions::V1::CallFunctionResponse
Pass arguments to call_function via a request object, either of type Google::Cloud::Functions::V1::CallFunctionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Functions::V1::CallFunctionRequest, ::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 call_function(name: nil, data: nil) -> ::Google::Cloud::Functions::V1::CallFunctionResponse
Pass arguments to call_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 to be called.
  • data (::String) — Required. Input to be passed to the function.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#configure

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

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

#create_function

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

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

Overloads 
def create_function(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_function via a request object, either of type Google::Cloud::Functions::V1::CreateFunctionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Functions::V1::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(location: nil, function: 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
  • location (::String) — Required. The project and location in which the function should be created, specified in the format projects/*/locations/*
  • function (::Google::Cloud::Functions::V1::CloudFunction, ::Hash) — Required. Function to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#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 is 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::V1::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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#generate_download_url

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

Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and must be used within minutes after 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::V1::GenerateDownloadUrlResponse
Pass arguments to generate_download_url via a request object, either of type GenerateDownloadUrlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Functions::V1::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, version_id: nil) -> ::Google::Cloud::Functions::V1::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).
Parameters
  • name (::String) — The name of function for which source code Google Cloud Storage signed URL should be generated.
  • version_id (::Integer) — The optional version of function. If not set, default, current version is used.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#generate_upload_url

def generate_upload_url(request, options = nil) -> ::Google::Cloud::Functions::V1::GenerateUploadUrlResponse
def generate_upload_url(parent: nil, kms_key_name: nil) -> ::Google::Cloud::Functions::V1::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.
  • Source file size should not exceed 100MB limit.
  • 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 an HTTP PUT request, these two headers must be specified:

  • content-type: application/zip
  • x-goog-content-length-range: 0,104857600

And this header must NOT be specified:

  • Authorization: Bearer YOUR_TOKEN
Overloads 
def generate_upload_url(request, options = nil) -> ::Google::Cloud::Functions::V1::GenerateUploadUrlResponse
Pass arguments to generate_upload_url via a request object, either of type GenerateUploadUrlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Functions::V1::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) -> ::Google::Cloud::Functions::V1::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) — 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) — Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in staging Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to a staging Cloud Storage bucket in an internal regional project. 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). GCF will delegate access to the Google Storage service account in the internal project.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_function

def get_function(request, options = nil) -> ::Google::Cloud::Functions::V1::CloudFunction
def get_function(name: nil) -> ::Google::Cloud::Functions::V1::CloudFunction

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

Overloads 
def get_function(request, options = nil) -> ::Google::Cloud::Functions::V1::CloudFunction
Pass arguments to get_function via a request object, either of type GetFunctionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Functions::V1::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) -> ::Google::Cloud::Functions::V1::CloudFunction
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).
Parameter
  • name (::String) — Required. The name of the function which details should be obtained.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Gets the IAM access control policy for a function. Returns an empty policy if the function exists and does not have a policy set.

Overloads 
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::GetIamPolicyRequest, ::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_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy 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
  • resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Google::Iam::V1::Policy)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Google::Iam::V1::Policy)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#iam_policy_client

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

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

Returns
  • (Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

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

Create a new CloudFunctionsService REST client object.

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

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

#list_functions

def list_functions(request, options = nil) -> ::Google::Cloud::Functions::V1::ListFunctionsResponse
def list_functions(parent: nil, page_size: nil, page_token: nil) -> ::Google::Cloud::Functions::V1::ListFunctionsResponse

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

Overloads 
def list_functions(request, options = nil) -> ::Google::Cloud::Functions::V1::ListFunctionsResponse
Pass arguments to list_functions via a request object, either of type ListFunctionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Functions::V1::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) -> ::Google::Cloud::Functions::V1::ListFunctionsResponse
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) — 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.
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

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

#operations_client

def operations_client() -> ::Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Operations

Get the associated client for long-running operations.

Returns

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Sets the IAM access control policy on the specified function. Replaces any existing policy.

Overloads 
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::SetIamPolicyRequest, ::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 set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy 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
  • resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

    paths: "bindings, etag"

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Google::Iam::V1::Policy)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Google::Iam::V1::Policy)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Tests the specified permissions against the IAM access control policy for a function. If the function does not exist, this returns an empty set of permissions, not a NOT_FOUND error.

Overloads 
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::TestIamPermissionsRequest, ::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 test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions 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
  • resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Google::Iam::V1::TestIamPermissionsResponse)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Google::Iam::V1::TestIamPermissionsResponse)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#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::V1::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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.