Interface CloudFunctionsServiceGrpc.AsyncService (2.47.0)

Version 2.47.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.4
• 2.4.3
• 2.3.6

public static interface CloudFunctionsServiceGrpc.AsyncService

A service that application uses to manipulate triggers and functions.

Methods

callFunction(CallFunctionRequest request, StreamObserver<CallFunctionResponse> responseObserver)

public default void callFunction(CallFunctionRequest request, StreamObserver<CallFunctionResponse> responseObserver)

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.

Parameters
Name	Description
request	CallFunctionRequest
responseObserver	io.grpc.stub.StreamObserver<CallFunctionResponse>

createFunction(CreateFunctionRequest request, StreamObserver<Operation> responseObserver)

public default 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 default 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 default 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 minutes after 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 default 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.
• 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

Parameters
Name	Description
request	GenerateUploadUrlRequest
responseObserver	io.grpc.stub.StreamObserver<GenerateUploadUrlResponse>

getFunction(GetFunctionRequest request, StreamObserver<CloudFunction> responseObserver)

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

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

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

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

Parameters
Name	Description
request	com.google.iam.v1.GetIamPolicyRequest
responseObserver	io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

listFunctions(ListFunctionsRequest request, StreamObserver<ListFunctionsResponse> responseObserver)

public default 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>

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

Parameters
Name	Description
request	com.google.iam.v1.SetIamPolicyRequest
responseObserver	io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public default void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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.

Parameters
Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest
responseObserver	io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>

updateFunction(UpdateFunctionRequest request, StreamObserver<Operation> responseObserver)

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

Updates existing function.

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