Class FunctionServiceGrpc.FunctionServiceStub (2.57.0)

public static final class FunctionServiceGrpc.FunctionServiceStub extends AbstractAsyncStub<FunctionServiceGrpc.FunctionServiceStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > FunctionServiceGrpc.FunctionServiceStub

Methods

build(Channel channel, CallOptions callOptions)

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

createFunction(CreateFunctionRequest request, StreamObserver<Operation> responseObserver)

public void createFunction(CreateFunctionRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request CreateFunctionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteFunction(DeleteFunctionRequest request, StreamObserver<Operation> responseObserver)

public void deleteFunction(DeleteFunctionRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request DeleteFunctionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

generateDownloadUrl(GenerateDownloadUrlRequest request, StreamObserver<GenerateDownloadUrlResponse> responseObserver)

public void generateDownloadUrl(GenerateDownloadUrlRequest request, StreamObserver<GenerateDownloadUrlResponse> responseObserver)

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

Parameters
Name Description
request GenerateDownloadUrlRequest
responseObserver io.grpc.stub.StreamObserver<GenerateDownloadUrlResponse>

generateUploadUrl(GenerateUploadUrlRequest request, StreamObserver<GenerateUploadUrlResponse> responseObserver)

public void generateUploadUrl(GenerateUploadUrlRequest request, StreamObserver<GenerateUploadUrlResponse> responseObserver)

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
Parameters
Name Description
request GenerateUploadUrlRequest
responseObserver io.grpc.stub.StreamObserver<GenerateUploadUrlResponse>

getFunction(GetFunctionRequest request, StreamObserver<Function> responseObserver)

public void getFunction(GetFunctionRequest request, StreamObserver<Function> responseObserver)

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

Parameters
Name Description
request GetFunctionRequest
responseObserver io.grpc.stub.StreamObserver<Function>

listFunctions(ListFunctionsRequest request, StreamObserver<ListFunctionsResponse> responseObserver)

public void listFunctions(ListFunctionsRequest request, StreamObserver<ListFunctionsResponse> responseObserver)

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

Parameters
Name Description
request ListFunctionsRequest
responseObserver io.grpc.stub.StreamObserver<ListFunctionsResponse>

listRuntimes(ListRuntimesRequest request, StreamObserver<ListRuntimesResponse> responseObserver)

public void listRuntimes(ListRuntimesRequest request, StreamObserver<ListRuntimesResponse> responseObserver)

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

Parameters
Name Description
request ListRuntimesRequest
responseObserver io.grpc.stub.StreamObserver<ListRuntimesResponse>

updateFunction(UpdateFunctionRequest request, StreamObserver<Operation> responseObserver)

public void updateFunction(UpdateFunctionRequest request, StreamObserver<Operation> responseObserver)

Updates existing function.

Parameters
Name Description
request UpdateFunctionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>