Class FunctionServiceGrpc.FunctionServiceFutureStub (2.55.0)

public static final class FunctionServiceGrpc.FunctionServiceFutureStub extends AbstractFutureStub<FunctionServiceGrpc.FunctionServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service FunctionService.

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > FunctionServiceGrpc.FunctionServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected FunctionServiceGrpc.FunctionServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
FunctionServiceGrpc.FunctionServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createFunction(CreateFunctionRequest request)

public ListenableFuture<Operation> createFunction(CreateFunctionRequest request)

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.

Parameter
Name Description
request CreateFunctionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteFunction(DeleteFunctionRequest request)

public ListenableFuture<Operation> deleteFunction(DeleteFunctionRequest request)

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.

Parameter
Name Description
request DeleteFunctionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

generateDownloadUrl(GenerateDownloadUrlRequest request)

public ListenableFuture<GenerateDownloadUrlResponse> generateDownloadUrl(GenerateDownloadUrlRequest request)

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

Parameter
Name Description
request GenerateDownloadUrlRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GenerateDownloadUrlResponse>

generateUploadUrl(GenerateUploadUrlRequest request)

public ListenableFuture<GenerateUploadUrlResponse> generateUploadUrl(GenerateUploadUrlRequest request)

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
Parameter
Name Description
request GenerateUploadUrlRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GenerateUploadUrlResponse>

getFunction(GetFunctionRequest request)

public ListenableFuture<Function> getFunction(GetFunctionRequest request)

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

Parameter
Name Description
request GetFunctionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Function>

listFunctions(ListFunctionsRequest request)

public ListenableFuture<ListFunctionsResponse> listFunctions(ListFunctionsRequest request)

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

Parameter
Name Description
request ListFunctionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListFunctionsResponse>

listRuntimes(ListRuntimesRequest request)

public ListenableFuture<ListRuntimesResponse> listRuntimes(ListRuntimesRequest request)

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

Parameter
Name Description
request ListRuntimesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListRuntimesResponse>

updateFunction(UpdateFunctionRequest request)

public ListenableFuture<Operation> updateFunction(UpdateFunctionRequest request)

Updates existing function.

Parameter
Name Description
request UpdateFunctionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>