Class CloudFunctionsServiceClient (2.62.0)
Stay organized with collections Save and categorize content based on your preferences.

Service Description: A service that application uses to manipulate triggers and functions.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CloudFunctionNamename=CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]");CloudFunctionresponse=cloudFunctionsServiceClient.getFunction(name);}

Note: close() needs to be called on the CloudFunctionsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
ListFunctions	Returns a list of functions that belong to the requested project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listFunctions(ListFunctionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listFunctionsPagedCallable() listFunctionsCallable()
GetFunction	Returns a function with the given name from the requested project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getFunction(GetFunctionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getFunction(CloudFunctionName name) getFunction(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getFunctionCallable()
CreateFunction	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createFunctionAsync(CreateFunctionRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createFunctionAsync(LocationName location, CloudFunction function) createFunctionAsync(String location, CloudFunction function) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createFunctionOperationCallable() createFunctionCallable()
UpdateFunction	Updates existing function.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateFunctionAsync(UpdateFunctionRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateFunctionAsync(CloudFunction function) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateFunctionOperationCallable() updateFunctionCallable()
DeleteFunction	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteFunctionAsync(DeleteFunctionRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteFunctionAsync(CloudFunctionName name) deleteFunctionAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteFunctionOperationCallable() deleteFunctionCallable()
CallFunction	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. callFunction(CallFunctionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. callFunction(CloudFunctionName name, String data) callFunction(String name, String data) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. callFunctionCallable()
GenerateUploadUrl	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`	Request object method variants only take one parameter, a request object, which must be constructed before the call. generateUploadUrl(GenerateUploadUrlRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. generateUploadUrlCallable()
GenerateDownloadUrl	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	Request object method variants only take one parameter, a request object, which must be constructed before the call. generateDownloadUrl(GenerateDownloadUrlRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. generateDownloadUrlCallable()
SetIamPolicy	Sets the IAM access control policy on the specified function. Replaces any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the IAM access control policy for a function. Returns an empty policy if the function exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CloudFunctionsServiceSettings to create(). For example:

To customize credentials:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_libraryCloudFunctionsServiceSettingscloudFunctionsServiceSettings=CloudFunctionsServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)).build();CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create(cloudFunctionsServiceSettings);

To customize the endpoint:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_libraryCloudFunctionsServiceSettingscloudFunctionsServiceSettings=CloudFunctionsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create(cloudFunctionsServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_libraryCloudFunctionsServiceSettingscloudFunctionsServiceSettings=CloudFunctionsServiceSettings.newHttpJsonBuilder().build();CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create(cloudFunctionsServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > CloudFunctionsServiceClient

Static Methods

create()

publicstaticfinalCloudFunctionsServiceClientcreate()

Constructs an instance of CloudFunctionsServiceClient with default settings.

Returns
Type	Description
`CloudFunctionsServiceClient`

Exceptions
Type	Description
`IOException`

create(CloudFunctionsServiceSettings settings)

publicstaticfinalCloudFunctionsServiceClientcreate(CloudFunctionsServiceSettingssettings)

Constructs an instance of CloudFunctionsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`CloudFunctionsServiceSettings`

Returns
Type	Description
`CloudFunctionsServiceClient`

Exceptions
Type	Description
`IOException`

create(CloudFunctionsServiceStub stub)

publicstaticfinalCloudFunctionsServiceClientcreate(CloudFunctionsServiceStubstub)

Constructs an instance of CloudFunctionsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudFunctionsServiceSettings).

Parameter
Name	Description
`stub`	`CloudFunctionsServiceStub`

Returns
Type	Description
`CloudFunctionsServiceClient`

Constructors

CloudFunctionsServiceClient(CloudFunctionsServiceSettings settings)

protectedCloudFunctionsServiceClient(CloudFunctionsServiceSettingssettings)

Constructs an instance of CloudFunctionsServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`CloudFunctionsServiceSettings`

CloudFunctionsServiceClient(CloudFunctionsServiceStub stub)

protectedCloudFunctionsServiceClient(CloudFunctionsServiceStubstub)

Parameter
Name	Description
`stub`	`CloudFunctionsServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

publicbooleanawaitTermination(longduration,TimeUnitunit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

callFunction(CallFunctionRequest request)

publicfinalCallFunctionResponsecallFunction(CallFunctionRequestrequest)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CallFunctionRequestrequest=CallFunctionRequest.newBuilder().setName(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).setData("data3076010").build();CallFunctionResponseresponse=cloudFunctionsServiceClient.callFunction(request);}

Parameter
Name	Description
`request`	`CallFunctionRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CallFunctionResponse`

callFunction(CloudFunctionName name, String data)

publicfinalCallFunctionResponsecallFunction(CloudFunctionNamename,Stringdata)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CloudFunctionNamename=CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]");Stringdata="data3076010";CallFunctionResponseresponse=cloudFunctionsServiceClient.callFunction(name,data);}

Parameters
Name	Description
`name`	`CloudFunctionName` Required. The name of the function to be called.
`data`	`String` Required. Input to be passed to the function.

Returns
Type	Description
`CallFunctionResponse`

callFunction(String name, String data)

publicfinalCallFunctionResponsecallFunction(Stringname,Stringdata)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){Stringname=CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString();Stringdata="data3076010";CallFunctionResponseresponse=cloudFunctionsServiceClient.callFunction(name,data);}

Parameters
Name	Description
`name`	`String` Required. The name of the function to be called.
`data`	`String` Required. Input to be passed to the function.

Returns
Type	Description
`CallFunctionResponse`

callFunctionCallable()

publicfinalUnaryCallable<CallFunctionRequest,CallFunctionResponse>callFunctionCallable()

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CallFunctionRequestrequest=CallFunctionRequest.newBuilder().setName(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).setData("data3076010").build();ApiFuture<CallFunctionResponse>future=cloudFunctionsServiceClient.callFunctionCallable().futureCall(request);// Do something.CallFunctionResponseresponse=future.get();}

Returns
Type	Description
`UnaryCallable<CallFunctionRequest,CallFunctionResponse>`

close()

publicfinalvoidclose()

createFunctionAsync(CreateFunctionRequest request)

publicfinalOperationFuture<CloudFunction,OperationMetadataV1>createFunctionAsync(CreateFunctionRequestrequest)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CreateFunctionRequestrequest=CreateFunctionRequest.newBuilder().setLocation(LocationName.of("[PROJECT]","[LOCATION]").toString()).setFunction(CloudFunction.newBuilder().build()).build();CloudFunctionresponse=cloudFunctionsServiceClient.createFunctionAsync(request).get();}

Parameter
Name	Description
`request`	`CreateFunctionRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<CloudFunction,OperationMetadataV1>`

createFunctionAsync(LocationName location, CloudFunction function)

publicfinalOperationFuture<CloudFunction,OperationMetadataV1>createFunctionAsync(LocationNamelocation,CloudFunctionfunction)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){LocationNamelocation=LocationName.of("[PROJECT]","[LOCATION]");CloudFunctionfunction=CloudFunction.newBuilder().build();CloudFunctionresponse=cloudFunctionsServiceClient.createFunctionAsync(location,function).get();}

Parameters
Name	Description
`location`	`LocationName` Required. The project and location in which the function should be created, specified in the format `projects//locations/`
`function`	`CloudFunction` Required. Function to be created.

Returns
Type	Description
`OperationFuture<CloudFunction,OperationMetadataV1>`

createFunctionAsync(String location, CloudFunction function)

publicfinalOperationFuture<CloudFunction,OperationMetadataV1>createFunctionAsync(Stringlocation,CloudFunctionfunction)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){Stringlocation=LocationName.of("[PROJECT]","[LOCATION]").toString();CloudFunctionfunction=CloudFunction.newBuilder().build();CloudFunctionresponse=cloudFunctionsServiceClient.createFunctionAsync(location,function).get();}

Parameters
Name	Description
`location`	`String` Required. The project and location in which the function should be created, specified in the format `projects//locations/`
`function`	`CloudFunction` Required. Function to be created.

Returns
Type	Description
`OperationFuture<CloudFunction,OperationMetadataV1>`

createFunctionCallable()

publicfinalUnaryCallable<CreateFunctionRequest,Operation>createFunctionCallable()

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CreateFunctionRequestrequest=CreateFunctionRequest.newBuilder().setLocation(LocationName.of("[PROJECT]","[LOCATION]").toString()).setFunction(CloudFunction.newBuilder().build()).build();ApiFuture<Operation>future=cloudFunctionsServiceClient.createFunctionCallable().futureCall(request);// Do something.Operationresponse=future.get();}

Returns
Type	Description
`UnaryCallable<CreateFunctionRequest,Operation>`

createFunctionOperationCallable()

publicfinalOperationCallable<CreateFunctionRequest,CloudFunction,OperationMetadataV1>createFunctionOperationCallable()

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CreateFunctionRequestrequest=CreateFunctionRequest.newBuilder().setLocation(LocationName.of("[PROJECT]","[LOCATION]").toString()).setFunction(CloudFunction.newBuilder().build()).build();OperationFuture<CloudFunction,OperationMetadataV1>future=cloudFunctionsServiceClient.createFunctionOperationCallable().futureCall(request);// Do something.CloudFunctionresponse=future.get();}

Returns
Type	Description
`OperationCallable<CreateFunctionRequest,CloudFunction,OperationMetadataV1>`

deleteFunctionAsync(CloudFunctionName name)

publicfinalOperationFuture<Empty,OperationMetadataV1>deleteFunctionAsync(CloudFunctionNamename)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CloudFunctionNamename=CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]");cloudFunctionsServiceClient.deleteFunctionAsync(name).get();}

Parameter
Name	Description
`name`	`CloudFunctionName` Required. The name of the function which should be deleted.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadataV1>`

deleteFunctionAsync(DeleteFunctionRequest request)

publicfinalOperationFuture<Empty,OperationMetadataV1>deleteFunctionAsync(DeleteFunctionRequestrequest)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){DeleteFunctionRequestrequest=DeleteFunctionRequest.newBuilder().setName(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).build();cloudFunctionsServiceClient.deleteFunctionAsync(request).get();}

Parameter
Name	Description
`request`	`DeleteFunctionRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadataV1>`

deleteFunctionAsync(String name)

publicfinalOperationFuture<Empty,OperationMetadataV1>deleteFunctionAsync(Stringname)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){Stringname=CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString();cloudFunctionsServiceClient.deleteFunctionAsync(name).get();}

Parameter
Name	Description
`name`	`String` Required. The name of the function which should be deleted.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadataV1>`

deleteFunctionCallable()

publicfinalUnaryCallable<DeleteFunctionRequest,Operation>deleteFunctionCallable()

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){DeleteFunctionRequestrequest=DeleteFunctionRequest.newBuilder().setName(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).build();ApiFuture<Operation>future=cloudFunctionsServiceClient.deleteFunctionCallable().futureCall(request);// Do something.future.get();}

Returns
Type	Description
`UnaryCallable<DeleteFunctionRequest,Operation>`

deleteFunctionOperationCallable()

publicfinalOperationCallable<DeleteFunctionRequest,Empty,OperationMetadataV1>deleteFunctionOperationCallable()

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){DeleteFunctionRequestrequest=DeleteFunctionRequest.newBuilder().setName(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).build();OperationFuture<Empty,OperationMetadataV1>future=cloudFunctionsServiceClient.deleteFunctionOperationCallable().futureCall(request);// Do something.future.get();}

Returns
Type	Description
`OperationCallable<DeleteFunctionRequest,Empty,OperationMetadataV1>`

generateDownloadUrl(GenerateDownloadUrlRequest request)

publicfinalGenerateDownloadUrlResponsegenerateDownloadUrl(GenerateDownloadUrlRequestrequest)

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){GenerateDownloadUrlRequestrequest=GenerateDownloadUrlRequest.newBuilder().setName("name3373707").setVersionId(-670497310).build();GenerateDownloadUrlResponseresponse=cloudFunctionsServiceClient.generateDownloadUrl(request);}

Parameter
Name	Description
`request`	`GenerateDownloadUrlRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`GenerateDownloadUrlResponse`

generateDownloadUrlCallable()

publicfinalUnaryCallable<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>generateDownloadUrlCallable()

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){GenerateDownloadUrlRequestrequest=GenerateDownloadUrlRequest.newBuilder().setName("name3373707").setVersionId(-670497310).build();ApiFuture<GenerateDownloadUrlResponse>future=cloudFunctionsServiceClient.generateDownloadUrlCallable().futureCall(request);// Do something.GenerateDownloadUrlResponseresponse=future.get();}

Returns
Type	Description
`UnaryCallable<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>`

generateUploadUrl(GenerateUploadUrlRequest request)

publicfinalGenerateUploadUrlResponsegenerateUploadUrl(GenerateUploadUrlRequestrequest)

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){GenerateUploadUrlRequestrequest=GenerateUploadUrlRequest.newBuilder().setParent("parent-995424086").setKmsKeyName(CryptoKeyName.of("[PROJECT]","[LOCATION]","[KEY_RING]","[CRYPTO_KEY]").toString()).build();GenerateUploadUrlResponseresponse=cloudFunctionsServiceClient.generateUploadUrl(request);}

Parameter
Name	Description
`request`	`GenerateUploadUrlRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`GenerateUploadUrlResponse`

generateUploadUrlCallable()

publicfinalUnaryCallable<GenerateUploadUrlRequest,GenerateUploadUrlResponse>generateUploadUrlCallable()

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){GenerateUploadUrlRequestrequest=GenerateUploadUrlRequest.newBuilder().setParent("parent-995424086").setKmsKeyName(CryptoKeyName.of("[PROJECT]","[LOCATION]","[KEY_RING]","[CRYPTO_KEY]").toString()).build();ApiFuture<GenerateUploadUrlResponse>future=cloudFunctionsServiceClient.generateUploadUrlCallable().futureCall(request);// Do something.GenerateUploadUrlResponseresponse=future.get();}

Returns
Type	Description
`UnaryCallable<GenerateUploadUrlRequest,GenerateUploadUrlResponse>`

getFunction(CloudFunctionName name)

publicfinalCloudFunctiongetFunction(CloudFunctionNamename)

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CloudFunctionNamename=CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]");CloudFunctionresponse=cloudFunctionsServiceClient.getFunction(name);}

Parameter
Name	Description
`name`	`CloudFunctionName` Required. The name of the function which details should be obtained.

Returns
Type	Description
`CloudFunction`

getFunction(GetFunctionRequest request)

publicfinalCloudFunctiongetFunction(GetFunctionRequestrequest)

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){GetFunctionRequestrequest=GetFunctionRequest.newBuilder().setName(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).setVersionId(-670497310).build();CloudFunctionresponse=cloudFunctionsServiceClient.getFunction(request);}

Parameter
Name	Description
`request`	`GetFunctionRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudFunction`

getFunction(String name)

publicfinalCloudFunctiongetFunction(Stringname)

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){Stringname=CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString();CloudFunctionresponse=cloudFunctionsServiceClient.getFunction(name);}

Parameter
Name	Description
`name`	`String` Required. The name of the function which details should be obtained.

Returns
Type	Description
`CloudFunction`

getFunctionCallable()

publicfinalUnaryCallable<GetFunctionRequest,CloudFunction>getFunctionCallable()

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){GetFunctionRequestrequest=GetFunctionRequest.newBuilder().setName(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).setVersionId(-670497310).build();ApiFuture<CloudFunction>future=cloudFunctionsServiceClient.getFunctionCallable().futureCall(request);// Do something.CloudFunctionresponse=future.get();}

Returns
Type	Description
`UnaryCallable<GetFunctionRequest,CloudFunction>`

getHttpJsonOperationsClient()

publicfinalOperationsClientgetHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getIamPolicy(GetIamPolicyRequest request)

publicfinalPolicygetIamPolicy(GetIamPolicyRequestrequest)

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){GetIamPolicyRequestrequest=GetIamPolicyRequest.newBuilder().setResource(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).setOptions(GetPolicyOptions.newBuilder().build()).build();Policyresponse=cloudFunctionsServiceClient.getIamPolicy(request);}

Parameter
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicyCallable()

publicfinalUnaryCallable<GetIamPolicyRequest,Policy>getIamPolicyCallable()

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){GetIamPolicyRequestrequest=GetIamPolicyRequest.newBuilder().setResource(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).setOptions(GetPolicyOptions.newBuilder().build()).build();ApiFuture<Policy>future=cloudFunctionsServiceClient.getIamPolicyCallable().futureCall(request);// Do something.Policyresponse=future.get();}

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getOperationsClient()

publicfinalOperationsClientgetOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getSettings()

publicfinalCloudFunctionsServiceSettingsgetSettings()

Returns
Type	Description
`CloudFunctionsServiceSettings`

getStub()

publicCloudFunctionsServiceStubgetStub()

Returns
Type	Description
`CloudFunctionsServiceStub`

isShutdown()

publicbooleanisShutdown()

Returns
Type	Description
`boolean`

isTerminated()

publicbooleanisTerminated()

Returns
Type	Description
`boolean`

listFunctions(ListFunctionsRequest request)

publicfinalCloudFunctionsServiceClient.ListFunctionsPagedResponselistFunctions(ListFunctionsRequestrequest)

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){ListFunctionsRequestrequest=ListFunctionsRequest.newBuilder().setParent(LocationName.of("[PROJECT]","[LOCATION]").toString()).setPageSize(883849137).setPageToken("pageToken873572522").build();for(CloudFunctionelement:cloudFunctionsServiceClient.listFunctions(request).iterateAll()){// doThingsWith(element);}}

Parameter
Name	Description
`request`	`ListFunctionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudFunctionsServiceClient.ListFunctionsPagedResponse`

listFunctionsCallable()

publicfinalUnaryCallable<ListFunctionsRequest,ListFunctionsResponse>listFunctionsCallable()

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){ListFunctionsRequestrequest=ListFunctionsRequest.newBuilder().setParent(LocationName.of("[PROJECT]","[LOCATION]").toString()).setPageSize(883849137).setPageToken("pageToken873572522").build();while(true){ListFunctionsResponseresponse=cloudFunctionsServiceClient.listFunctionsCallable().call(request);for(CloudFunctionelement:response.getFunctionsList()){// doThingsWith(element);}StringnextPageToken=response.getNextPageToken();if(!Strings.isNullOrEmpty(nextPageToken)){request=request.toBuilder().setPageToken(nextPageToken).build();}else{break;}}}

Returns
Type	Description
`UnaryCallable<ListFunctionsRequest,ListFunctionsResponse>`

listFunctionsPagedCallable()

publicfinalUnaryCallable<ListFunctionsRequest,CloudFunctionsServiceClient.ListFunctionsPagedResponse>listFunctionsPagedCallable()

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){ListFunctionsRequestrequest=ListFunctionsRequest.newBuilder().setParent(LocationName.of("[PROJECT]","[LOCATION]").toString()).setPageSize(883849137).setPageToken("pageToken873572522").build();ApiFuture<CloudFunction>future=cloudFunctionsServiceClient.listFunctionsPagedCallable().futureCall(request);// Do something.for(CloudFunctionelement:future.get().iterateAll()){// doThingsWith(element);}}

Returns
Type	Description
`UnaryCallable<ListFunctionsRequest,ListFunctionsPagedResponse>`

listLocations(ListLocationsRequest request)

publicfinalCloudFunctionsServiceClient.ListLocationsPagedResponselistLocations(ListLocationsRequestrequest)

Lists information about the supported locations for this service.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){ListLocationsRequestrequest=ListLocationsRequest.newBuilder().setName("name3373707").setFilter("filter-1274492040").setPageSize(883849137).setPageToken("pageToken873572522").build();for(Locationelement:cloudFunctionsServiceClient.listLocations(request).iterateAll()){// doThingsWith(element);}}

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudFunctionsServiceClient.ListLocationsPagedResponse`

listLocationsCallable()

publicfinalUnaryCallable<ListLocationsRequest,ListLocationsResponse>listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){ListLocationsRequestrequest=ListLocationsRequest.newBuilder().setName("name3373707").setFilter("filter-1274492040").setPageSize(883849137).setPageToken("pageToken873572522").build();while(true){ListLocationsResponseresponse=cloudFunctionsServiceClient.listLocationsCallable().call(request);for(Locationelement:response.getLocationsList()){// doThingsWith(element);}StringnextPageToken=response.getNextPageToken();if(!Strings.isNullOrEmpty(nextPageToken)){request=request.toBuilder().setPageToken(nextPageToken).build();}else{break;}}}

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

publicfinalUnaryCallable<ListLocationsRequest,CloudFunctionsServiceClient.ListLocationsPagedResponse>listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){ListLocationsRequestrequest=ListLocationsRequest.newBuilder().setName("name3373707").setFilter("filter-1274492040").setPageSize(883849137).setPageToken("pageToken873572522").build();ApiFuture<Location>future=cloudFunctionsServiceClient.listLocationsPagedCallable().futureCall(request);// Do something.for(Locationelement:future.get().iterateAll()){// doThingsWith(element);}}

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

setIamPolicy(SetIamPolicyRequest request)

publicfinalPolicysetIamPolicy(SetIamPolicyRequestrequest)

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){SetIamPolicyRequestrequest=SetIamPolicyRequest.newBuilder().setResource(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).setPolicy(Policy.newBuilder().build()).setUpdateMask(FieldMask.newBuilder().build()).build();Policyresponse=cloudFunctionsServiceClient.setIamPolicy(request);}

Parameter
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

setIamPolicyCallable()

publicfinalUnaryCallable<SetIamPolicyRequest,Policy>setIamPolicyCallable()

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

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){SetIamPolicyRequestrequest=SetIamPolicyRequest.newBuilder().setResource(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).setPolicy(Policy.newBuilder().build()).setUpdateMask(FieldMask.newBuilder().build()).build();ApiFuture<Policy>future=cloudFunctionsServiceClient.setIamPolicyCallable().futureCall(request);// Do something.Policyresponse=future.get();}

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

publicfinalTestIamPermissionsResponsetestIamPermissions(TestIamPermissionsRequestrequest)

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){TestIamPermissionsRequestrequest=TestIamPermissionsRequest.newBuilder().setResource(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).addAllPermissions(newArrayList<String>()).build();TestIamPermissionsResponseresponse=cloudFunctionsServiceClient.testIamPermissions(request);}

Parameter
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

testIamPermissionsCallable()

publicfinalUnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse>testIamPermissionsCallable()

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.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){TestIamPermissionsRequestrequest=TestIamPermissionsRequest.newBuilder().setResource(CloudFunctionName.of("[PROJECT]","[LOCATION]","[FUNCTION]").toString()).addAllPermissions(newArrayList<String>()).build();ApiFuture<TestIamPermissionsResponse>future=cloudFunctionsServiceClient.testIamPermissionsCallable().futureCall(request);// Do something.TestIamPermissionsResponseresponse=future.get();}

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

updateFunctionAsync(CloudFunction function)

publicfinalOperationFuture<CloudFunction,OperationMetadataV1>updateFunctionAsync(CloudFunctionfunction)

Updates existing function.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){CloudFunctionfunction=CloudFunction.newBuilder().build();CloudFunctionresponse=cloudFunctionsServiceClient.updateFunctionAsync(function).get();}

Parameter
Name	Description
`function`	`CloudFunction` Required. New version of the function.

Returns
Type	Description
`OperationFuture<CloudFunction,OperationMetadataV1>`

updateFunctionAsync(UpdateFunctionRequest request)

publicfinalOperationFuture<CloudFunction,OperationMetadataV1>updateFunctionAsync(UpdateFunctionRequestrequest)

Updates existing function.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){UpdateFunctionRequestrequest=UpdateFunctionRequest.newBuilder().setFunction(CloudFunction.newBuilder().build()).setUpdateMask(FieldMask.newBuilder().build()).build();CloudFunctionresponse=cloudFunctionsServiceClient.updateFunctionAsync(request).get();}

Parameter
Name	Description
`request`	`UpdateFunctionRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<CloudFunction,OperationMetadataV1>`

updateFunctionCallable()

publicfinalUnaryCallable<UpdateFunctionRequest,Operation>updateFunctionCallable()

Updates existing function.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){UpdateFunctionRequestrequest=UpdateFunctionRequest.newBuilder().setFunction(CloudFunction.newBuilder().build()).setUpdateMask(FieldMask.newBuilder().build()).build();ApiFuture<Operation>future=cloudFunctionsServiceClient.updateFunctionCallable().futureCall(request);// Do something.Operationresponse=future.get();}

Returns
Type	Description
`UnaryCallable<UpdateFunctionRequest,Operation>`

updateFunctionOperationCallable()

publicfinalOperationCallable<UpdateFunctionRequest,CloudFunction,OperationMetadataV1>updateFunctionOperationCallable()

Updates existing function.

Sample code:

// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(CloudFunctionsServiceClientcloudFunctionsServiceClient=CloudFunctionsServiceClient.create()){UpdateFunctionRequestrequest=UpdateFunctionRequest.newBuilder().setFunction(CloudFunction.newBuilder().build()).setUpdateMask(FieldMask.newBuilder().build()).build();OperationFuture<CloudFunction,OperationMetadataV1>future=cloudFunctionsServiceClient.updateFunctionOperationCallable().futureCall(request);// Do something.CloudFunctionresponse=future.get();}

Returns
Type	Description
`OperationCallable<UpdateFunctionRequest,CloudFunction,OperationMetadataV1>`

Class CloudFunctionsServiceClient (2.62.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(CloudFunctionsServiceSettings settings)

create(CloudFunctionsServiceStub stub)

Constructors

CloudFunctionsServiceClient(CloudFunctionsServiceSettings settings)

CloudFunctionsServiceClient(CloudFunctionsServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

callFunction(CallFunctionRequest request)

callFunction(CloudFunctionName name, String data)

callFunction(String name, String data)

callFunctionCallable()

close()

createFunctionAsync(CreateFunctionRequest request)

createFunctionAsync(LocationName location, CloudFunction function)

createFunctionAsync(String location, CloudFunction function)

createFunctionCallable()

createFunctionOperationCallable()

deleteFunctionAsync(CloudFunctionName name)

deleteFunctionAsync(DeleteFunctionRequest request)

deleteFunctionAsync(String name)

deleteFunctionCallable()

deleteFunctionOperationCallable()

generateDownloadUrl(GenerateDownloadUrlRequest request)

generateDownloadUrlCallable()

generateUploadUrl(GenerateUploadUrlRequest request)

generateUploadUrlCallable()

getFunction(CloudFunctionName name)

getFunction(GetFunctionRequest request)

getFunction(String name)

getFunctionCallable()

getHttpJsonOperationsClient()

getIamPolicy(GetIamPolicyRequest request)

getIamPolicyCallable()

getOperationsClient()

getSettings()

getStub()

isShutdown()

isTerminated()

listFunctions(ListFunctionsRequest request)

listFunctionsCallable()

listFunctionsPagedCallable()

listLocations(ListLocationsRequest request)

listLocationsCallable()

listLocationsPagedCallable()

setIamPolicy(SetIamPolicyRequest request)

setIamPolicyCallable()

shutdown()

shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

testIamPermissionsCallable()

updateFunctionAsync(CloudFunction function)

updateFunctionAsync(UpdateFunctionRequest request)

updateFunctionCallable()

updateFunctionOperationCallable()

Class CloudFunctionsServiceClient (2.62.0)
Stay organized with collections Save and categorize content based on your preferences.