Class CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub (2.25.0)

public static final class CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub extends AbstractFutureStub<CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub>

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

A service that application uses to manipulate triggers and functions.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
CloudFunctionsServiceGrpc.CloudFunctionsServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

callFunction(CallFunctionRequest request)

public ListenableFuture<CallFunctionResponse> callFunction(CallFunctionRequest request)

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.

Parameter
NameDescription
requestCallFunctionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CallFunctionResponse>

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 returns an ALREADY_EXISTS error.

Parameter
NameDescription
requestCreateFunctionRequest
Returns
TypeDescription
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 is updated to remove this function.

Parameter
NameDescription
requestDeleteFunctionRequest
Returns
TypeDescription
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 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

Parameter
NameDescription
requestGenerateDownloadUrlRequest
Returns
TypeDescription
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.
  • 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
Parameter
NameDescription
requestGenerateUploadUrlRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GenerateUploadUrlResponse>

getFunction(GetFunctionRequest request)

public ListenableFuture<CloudFunction> getFunction(GetFunctionRequest request)

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

Parameter
NameDescription
requestGetFunctionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CloudFunction>

getIamPolicy(GetIamPolicyRequest request)

public ListenableFuture<Policy> getIamPolicy(GetIamPolicyRequest request)

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

Parameter
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

listFunctions(ListFunctionsRequest request)

public ListenableFuture<ListFunctionsResponse> listFunctions(ListFunctionsRequest request)

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

Parameter
NameDescription
requestListFunctionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListFunctionsResponse>

setIamPolicy(SetIamPolicyRequest request)

public ListenableFuture<Policy> setIamPolicy(SetIamPolicyRequest request)

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

Parameter
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request)

public ListenableFuture<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request)

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.

Parameter
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>

updateFunction(UpdateFunctionRequest request)

public ListenableFuture<Operation> updateFunction(UpdateFunctionRequest request)

Updates existing function.

Parameter
NameDescription
requestUpdateFunctionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>