Client for the CloudFunctionsService service.
A service that application uses to manipulate triggers and functions.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the CloudFunctionsService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all CloudFunctionsService clients ::Google::Cloud::Functions::V1::CloudFunctionsService::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.
def call_function(request, options = nil) -> ::Google::Cloud::Functions::V1::CallFunctionResponse
call_function
via a request object, either of type
Google::Cloud::Functions::V1::CallFunctionRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the function to be called.
- data (::String) — Required. Input to be passed to the function.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Functions::V1::CallFunctionResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Functions::V1::CallFunctionRequest.new # Call the call_function method. result = client.call_function request # The returned object is of type Google::Cloud::Functions::V1::CallFunctionResponse. p result
#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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#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 will return
ALREADY_EXISTS
error.
def create_function(request, options = nil) -> ::Gapic::Operation
create_function
via a request object, either of type
Google::Cloud::Functions::V1::CreateFunctionRequest or an equivalent Hash.
- 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
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).
-
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Functions::V1::CreateFunctionRequest.new # Call the create_function method. result = client.create_function request # The returned object is of type Gapic::Operation. You can use this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" 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.
def delete_function(request, options = nil) -> ::Gapic::Operation
delete_function
via a request object, either of type
DeleteFunctionRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the function which should be deleted.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Functions::V1::DeleteFunctionRequest.new # Call the delete_function method. result = client.delete_function request # The returned object is of type Gapic::Operation. You can use this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
#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 should 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
def generate_download_url(request, options = nil) -> ::Google::Cloud::Functions::V1::GenerateDownloadUrlResponse
generate_download_url
via a request object, either of type
GenerateDownloadUrlRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Functions::V1::GenerateDownloadUrlResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Functions::V1::GenerateDownloadUrlRequest.new # Call the generate_download_url method. result = client.generate_download_url request # The returned object is of type Google::Cloud::Functions::V1::GenerateDownloadUrlResponse. p result
#generate_upload_url
def generate_upload_url(request, options = nil) -> ::Google::Cloud::Functions::V1::GenerateUploadUrlResponse
def generate_upload_url(parent: 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 a HTTP PUT request, these two headers need to be specified:
content-type: application/zip
x-goog-content-length-range: 0,104857600
And this header SHOULD NOT be specified:
Authorization: Bearer YOUR_TOKEN
def generate_upload_url(request, options = nil) -> ::Google::Cloud::Functions::V1::GenerateUploadUrlResponse
generate_upload_url
via a request object, either of type
GenerateUploadUrlRequest or an equivalent Hash.
- 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) -> ::Google::Cloud::Functions::V1::GenerateUploadUrlResponse
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).
-
parent (::String) — The project and location in which the Google Cloud Storage signed URL
should be generated, specified in the format
projects/*/locations/*
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Functions::V1::GenerateUploadUrlResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Functions::V1::GenerateUploadUrlRequest.new # Call the generate_upload_url method. result = client.generate_upload_url request # The returned object is of type Google::Cloud::Functions::V1::GenerateUploadUrlResponse. p result
#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.
def get_function(request, options = nil) -> ::Google::Cloud::Functions::V1::CloudFunction
get_function
via a request object, either of type
GetFunctionRequest or an equivalent Hash.
- 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
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).
- name (::String) — Required. The name of the function which details should be obtained.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Functions::V1::CloudFunction)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Functions::V1::GetFunctionRequest.new # Call the get_function method. result = client.get_function request # The returned object is of type Google::Cloud::Functions::V1::CloudFunction. p result
#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.
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
get_iam_policy
via a request object, either of type
Iam::V1::GetIamPolicyRequest or an equivalent Hash.
- 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
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).
- 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 toGetIamPolicy
. This field is only used by Cloud IAM.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::GetIamPolicyRequest.new # Call the get_iam_policy method. result = client.get_iam_policy request # The returned object is of type Google::Iam::V1::Policy. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new CloudFunctionsService client object.
- (config) — Configure the CloudFunctionsService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Functions::V1::CloudFunctionsService::Client.new do |config| config.timeout = 10.0 end
#list_functions
def list_functions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Functions::V1::CloudFunction>
def list_functions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Functions::V1::CloudFunction>
Returns a list of functions that belong to the requested project.
def list_functions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Functions::V1::CloudFunction>
list_functions
via a request object, either of type
ListFunctionsRequest or an equivalent Hash.
- 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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Functions::V1::CloudFunction>
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).
-
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 priorListFunctions
call, and that the system should return the next page of data.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Functions::V1::CloudFunction>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Functions::V1::CloudFunction>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Functions::V1::ListFunctionsRequest.new # Call the list_functions method. result = client.list_functions request # The returned object is of type Gapic::PagedEnumerable. You can # iterate over all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::Functions::V1::CloudFunction. p response end
#operations_client
def operations_client() -> ::Google::Cloud::Functions::V1::CloudFunctionsService::Operations
Get the associated client for long-running operations.
#set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil) -> ::Google::Iam::V1::Policy
Sets the IAM access control policy on the specified function. Replaces any existing policy.
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
set_iam_policy
via a request object, either of type
Iam::V1::SetIamPolicyRequest or an equivalent Hash.
- 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) -> ::Google::Iam::V1::Policy
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::SetIamPolicyRequest.new # Call the set_iam_policy method. result = client.set_iam_policy request # The returned object is of type Google::Iam::V1::Policy. p result
#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 will return an empty set of permissions, not a NOT_FOUND error.
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
via a request object, either of type
Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::TestIamPermissionsRequest.new # Call the test_iam_permissions method. result = client.test_iam_permissions request # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse. p result
#update_function
def update_function(request, options = nil) -> ::Gapic::Operation
def update_function(function: nil, update_mask: nil) -> ::Gapic::Operation
Updates existing function.
def update_function(request, options = nil) -> ::Gapic::Operation
update_function
via a request object, either of type
UpdateFunctionRequest or an equivalent Hash.
- 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
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).
- function (::Google::Cloud::Functions::V1::CloudFunction, ::Hash) — Required. New version of the function.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required list of fields to be updated in this request.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/functions/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Functions::V1::CloudFunctionsService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Functions::V1::UpdateFunctionRequest.new # Call the update_function method. result = client.update_function request # The returned object is of type Gapic::Operation. You can use this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end