Reference documentation and code samples for the Cloud Functions V2 API class Google::Cloud::Functions::V2::FunctionService::Rest::Client.
REST 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
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the FunctionService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all FunctionService clients ::Google::Cloud::Functions::V2::FunctionService::Rest::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.
- (config) — Configure the Client client.
- config (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.
def create_function(request, options = nil) -> ::Gapic::Operation
create_function
via a request object, either of type
CreateFunctionRequest or an equivalent Hash.
- 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
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).
-
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]-/.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::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 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::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
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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#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
def generate_download_url(request, options = nil) -> ::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse
generate_download_url
via a request object, either of type
GenerateDownloadUrlRequest or an equivalent Hash.
- 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
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) — Required. The name of function for which source code Google Cloud Storage signed URL should be generated.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#generate_upload_url
def generate_upload_url(request, options = nil) -> ::Google::Cloud::Functions::V2::GenerateUploadUrlResponse
def generate_upload_url(parent: 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, these two headers need to be specified:
content-type: application/zip
And this header SHOULD NOT be specified:
Authorization: Bearer YOUR_TOKEN
def generate_upload_url(request, options = nil) -> ::Google::Cloud::Functions::V2::GenerateUploadUrlResponse
generate_upload_url
via a request object, either of type
GenerateUploadUrlRequest or an equivalent Hash.
- 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) -> ::Google::Cloud::Functions::V2::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) — Required. The project and location in which the Google Cloud Storage signed URL
should be generated, specified in the format
projects/*/locations/*
.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Functions::V2::GenerateUploadUrlResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_function
def get_function(request, options = nil) -> ::Google::Cloud::Functions::V2::Function
def get_function(name: nil) -> ::Google::Cloud::Functions::V2::Function
Returns a function with the given name from the requested project.
def get_function(request, options = nil) -> ::Google::Cloud::Functions::V2::Function
get_function
via a request object, either of type
GetFunctionRequest or an equivalent Hash.
- 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) -> ::Google::Cloud::Functions::V2::Function
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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Functions::V2::Function)
- operation (::Gapic::Rest::TransportOperation)
- (::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.
- (Google::Iam::V1::IAMPolicy::Rest::Client)
#initialize
def initialize() { |config| ... } -> Client
Create a new FunctionService REST client object.
- (config) — Configure the FunctionService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Functions::V2::FunctionService::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Functions::V2::FunctionService::Rest::Client.new do |config| config.timeout = 10.0 end
#list_functions
def list_functions(request, options = nil) -> ::Google::Cloud::Functions::V2::ListFunctionsResponse
def list_functions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Functions::V2::ListFunctionsResponse
Returns a list of functions that belong to the requested project.
def list_functions(request, options = nil) -> ::Google::Cloud::Functions::V2::ListFunctionsResponse
list_functions
via a request object, either of type
ListFunctionsRequest or an equivalent Hash.
- 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) -> ::Google::Cloud::Functions::V2::ListFunctionsResponse
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) — 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.
-
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. - 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Functions::V2::ListFunctionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#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.
def list_runtimes(request, options = nil) -> ::Google::Cloud::Functions::V2::ListRuntimesResponse
list_runtimes
via a request object, either of type
ListRuntimesRequest or an equivalent Hash.
- 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
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).
-
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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Functions::V2::ListRuntimesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::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.
- (Google::Cloud::Location::Locations::Rest::Client)
#operations_client
def operations_client() -> ::Google::Cloud::Functions::V2::FunctionService::Rest::Operations
Get the associated client for long-running operations.
#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::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
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::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 provided fields in the request will be updated.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.