Class CloudFunctionsServiceClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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_library
try (CloudFunctionsServiceClient cloudFunctionsServiceClient =
CloudFunctionsServiceClient.create()) {
CloudFunctionName name = CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]");
CloudFunction response = 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().
| 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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateFunction |
Updates existing function. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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](https://cloud.google.com/functions/quotas#rate_limits). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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:
When making a HTTP PUT request, these two headers need to be specified:
And this header SHOULD NOT be specified:
|
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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_library
CloudFunctionsServiceSettings cloudFunctionsServiceSettings =
CloudFunctionsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CloudFunctionsServiceClient cloudFunctionsServiceClient =
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_library
CloudFunctionsServiceSettings cloudFunctionsServiceSettings =
CloudFunctionsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
CloudFunctionsServiceClient cloudFunctionsServiceClient =
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_library
CloudFunctionsServiceSettings cloudFunctionsServiceSettings =
CloudFunctionsServiceSettings.newHttpJsonBuilder().build();
CloudFunctionsServiceClient cloudFunctionsServiceClient =
CloudFunctionsServiceClient.create(cloudFunctionsServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructs an instance of CloudFunctionsServiceClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final CallFunctionResponsecallFunction(CallFunctionRequest request) Synchronously invokes a deployed Cloud Function.final CallFunctionResponsecallFunction(CloudFunctionName name, String data) Synchronously invokes a deployed Cloud Function.final CallFunctionResponsecallFunction(String name, String data) Synchronously invokes a deployed Cloud Function.Synchronously invokes a deployed Cloud Function.final voidclose()static final CloudFunctionsServiceClientcreate()Constructs an instance of CloudFunctionsServiceClient with default settings.static final CloudFunctionsServiceClientcreate(CloudFunctionsServiceSettings settings) Constructs an instance of CloudFunctionsServiceClient, using the given settings.static final CloudFunctionsServiceClientConstructs an instance of CloudFunctionsServiceClient, using the given stub for making calls.createFunctionAsync(CreateFunctionRequest request) Creates a new function.createFunctionAsync(LocationName location, CloudFunction function) Creates a new function.createFunctionAsync(String location, CloudFunction function) Creates a new function.Creates a new function.Creates a new function.final OperationFuture<com.google.protobuf.Empty,OperationMetadataV1> Deletes a function with the given name from the specified project.final OperationFuture<com.google.protobuf.Empty,OperationMetadataV1> deleteFunctionAsync(DeleteFunctionRequest request) Deletes a function with the given name from the specified project.final OperationFuture<com.google.protobuf.Empty,OperationMetadataV1> deleteFunctionAsync(String name) Deletes a function with the given name from the specified project.Deletes a function with the given name from the specified project.final OperationCallable<DeleteFunctionRequest,com.google.protobuf.Empty, OperationMetadataV1> Deletes a function with the given name from the specified project.Returns a signed URL for downloading deployed function source code.Returns a signed URL for downloading deployed function source code.Returns a signed URL for uploading a function source code.Returns a signed URL for uploading a function source code.final CloudFunctiongetFunction(CloudFunctionName name) Returns a function with the given name from the requested project.final CloudFunctiongetFunction(GetFunctionRequest request) Returns a function with the given name from the requested project.final CloudFunctiongetFunction(String name) Returns a function with the given name from the requested project.Returns a function with the given name from the requested project.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final PolicygetIamPolicy(GetIamPolicyRequest request) Gets the IAM access control policy for a function.Gets the IAM access control policy for a function.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.getStub()booleanbooleanlistFunctions(ListFunctionsRequest request) Returns a list of functions that belong to the requested project.Returns a list of functions that belong to the requested project.Returns a list of functions that belong to the requested project.listLocations(ListLocationsRequest request) Lists information about the supported locations for this service.Lists information about the supported locations for this service.Lists information about the supported locations for this service.final PolicysetIamPolicy(SetIamPolicyRequest request) Sets the IAM access control policy on the specified function.Sets the IAM access control policy on the specified function.voidshutdown()voidTests the specified permissions against the IAM access control policy for a function.Tests the specified permissions against the IAM access control policy for a function.updateFunctionAsync(CloudFunction function) Updates existing function.updateFunctionAsync(UpdateFunctionRequest request) Updates existing function.Updates existing function.Updates existing function.
-
Constructor Details
-
CloudFunctionsServiceClient
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.- Throws:
IOException
-
CloudFunctionsServiceClient
-
-
Method Details
-
create
Constructs an instance of CloudFunctionsServiceClient with default settings.- Throws:
IOException
-
create
public static final CloudFunctionsServiceClient create(CloudFunctionsServiceSettings settings) throws IOException 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.- Throws:
IOException
-
create
Constructs an instance of CloudFunctionsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudFunctionsServiceSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
getHttpJsonOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
listFunctions
public final CloudFunctionsServiceClient.ListFunctionsPagedResponse listFunctions(ListFunctionsRequest request) 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { ListFunctionsRequest request = ListFunctionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (CloudFunction element : cloudFunctionsServiceClient.listFunctions(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listFunctionsPagedCallable
public final UnaryCallable<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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { ListFunctionsRequest request = ListFunctionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<CloudFunction> future = cloudFunctionsServiceClient.listFunctionsPagedCallable().futureCall(request); // Do something. for (CloudFunction element : future.get().iterateAll()) { // doThingsWith(element); } } -
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { ListFunctionsRequest request = ListFunctionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListFunctionsResponse response = cloudFunctionsServiceClient.listFunctionsCallable().call(request); for (CloudFunction element : response.getFunctionsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getFunction
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CloudFunctionName name = CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]"); CloudFunction response = cloudFunctionsServiceClient.getFunction(name); }- Parameters:
name- Required. The name of the function which details should be obtained.- Throws:
ApiException- if the remote call fails
-
getFunction
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { String name = CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString(); CloudFunction response = cloudFunctionsServiceClient.getFunction(name); }- Parameters:
name- Required. The name of the function which details should be obtained.- Throws:
ApiException- if the remote call fails
-
getFunction
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GetFunctionRequest request = GetFunctionRequest.newBuilder() .setName(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setVersionId(-670497310) .build(); CloudFunction response = cloudFunctionsServiceClient.getFunction(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GetFunctionRequest request = GetFunctionRequest.newBuilder() .setName(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setVersionId(-670497310) .build(); ApiFuture<CloudFunction> future = cloudFunctionsServiceClient.getFunctionCallable().futureCall(request); // Do something. CloudFunction response = future.get(); } -
createFunctionAsync
public final OperationFuture<CloudFunction,OperationMetadataV1> createFunctionAsync(LocationName location, CloudFunction function) 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { LocationName location = LocationName.of("[PROJECT]", "[LOCATION]"); CloudFunction function = CloudFunction.newBuilder().build(); CloudFunction response = cloudFunctionsServiceClient.createFunctionAsync(location, function).get(); }- Parameters:
location- Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`function- Required. Function to be created.- Throws:
ApiException- if the remote call fails
-
createFunctionAsync
public final OperationFuture<CloudFunction,OperationMetadataV1> createFunctionAsync(String location, CloudFunction function) 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { String location = LocationName.of("[PROJECT]", "[LOCATION]").toString(); CloudFunction function = CloudFunction.newBuilder().build(); CloudFunction response = cloudFunctionsServiceClient.createFunctionAsync(location, function).get(); }- Parameters:
location- Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`function- Required. Function to be created.- Throws:
ApiException- if the remote call fails
-
createFunctionAsync
public final OperationFuture<CloudFunction,OperationMetadataV1> createFunctionAsync(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.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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CreateFunctionRequest request = CreateFunctionRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFunction(CloudFunction.newBuilder().build()) .build(); CloudFunction response = cloudFunctionsServiceClient.createFunctionAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createFunctionOperationCallable
public final OperationCallable<CreateFunctionRequest,CloudFunction, createFunctionOperationCallable()OperationMetadataV1> 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CreateFunctionRequest request = CreateFunctionRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFunction(CloudFunction.newBuilder().build()) .build(); OperationFuture<CloudFunction, OperationMetadataV1> future = cloudFunctionsServiceClient.createFunctionOperationCallable().futureCall(request); // Do something. CloudFunction response = future.get(); } -
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CreateFunctionRequest request = CreateFunctionRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFunction(CloudFunction.newBuilder().build()) .build(); ApiFuture<Operation> future = cloudFunctionsServiceClient.createFunctionCallable().futureCall(request); // Do something. Operation response = future.get(); } -
updateFunctionAsync
public final OperationFuture<CloudFunction,OperationMetadataV1> updateFunctionAsync(CloudFunction function) 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CloudFunction function = CloudFunction.newBuilder().build(); CloudFunction response = cloudFunctionsServiceClient.updateFunctionAsync(function).get(); }- Parameters:
function- Required. New version of the function.- Throws:
ApiException- if the remote call fails
-
updateFunctionAsync
public final OperationFuture<CloudFunction,OperationMetadataV1> updateFunctionAsync(UpdateFunctionRequest request) 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { UpdateFunctionRequest request = UpdateFunctionRequest.newBuilder() .setFunction(CloudFunction.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); CloudFunction response = cloudFunctionsServiceClient.updateFunctionAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateFunctionOperationCallable
public final OperationCallable<UpdateFunctionRequest,CloudFunction, updateFunctionOperationCallable()OperationMetadataV1> 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { UpdateFunctionRequest request = UpdateFunctionRequest.newBuilder() .setFunction(CloudFunction.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); OperationFuture<CloudFunction, OperationMetadataV1> future = cloudFunctionsServiceClient.updateFunctionOperationCallable().futureCall(request); // Do something. CloudFunction response = future.get(); } -
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { UpdateFunctionRequest request = UpdateFunctionRequest.newBuilder() .setFunction(CloudFunction.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Operation> future = cloudFunctionsServiceClient.updateFunctionCallable().futureCall(request); // Do something. Operation response = future.get(); } -
deleteFunctionAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadataV1> deleteFunctionAsync(CloudFunctionName name) 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CloudFunctionName name = CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]"); cloudFunctionsServiceClient.deleteFunctionAsync(name).get(); }- Parameters:
name- Required. The name of the function which should be deleted.- Throws:
ApiException- if the remote call fails
-
deleteFunctionAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadataV1> deleteFunctionAsync(String name) 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { String name = CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString(); cloudFunctionsServiceClient.deleteFunctionAsync(name).get(); }- Parameters:
name- Required. The name of the function which should be deleted.- Throws:
ApiException- if the remote call fails
-
deleteFunctionAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadataV1> deleteFunctionAsync(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.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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { DeleteFunctionRequest request = DeleteFunctionRequest.newBuilder() .setName(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); cloudFunctionsServiceClient.deleteFunctionAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteFunctionOperationCallable
public final OperationCallable<DeleteFunctionRequest,com.google.protobuf.Empty, deleteFunctionOperationCallable()OperationMetadataV1> 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { DeleteFunctionRequest request = DeleteFunctionRequest.newBuilder() .setName(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); OperationFuture<Empty, OperationMetadataV1> future = cloudFunctionsServiceClient.deleteFunctionOperationCallable().futureCall(request); // Do something. future.get(); } -
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { DeleteFunctionRequest request = DeleteFunctionRequest.newBuilder() .setName(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); ApiFuture<Operation> future = cloudFunctionsServiceClient.deleteFunctionCallable().futureCall(request); // Do something. future.get(); } -
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](https://cloud.google.com/functions/quotas#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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CloudFunctionName name = CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]"); String data = "data3076010"; CallFunctionResponse response = cloudFunctionsServiceClient.callFunction(name, data); }- Parameters:
name- Required. The name of the function to be called.data- Required. Input to be passed to the function.- Throws:
ApiException- if the remote call fails
-
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](https://cloud.google.com/functions/quotas#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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { String name = CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString(); String data = "data3076010"; CallFunctionResponse response = cloudFunctionsServiceClient.callFunction(name, data); }- Parameters:
name- Required. The name of the function to be called.data- Required. Input to be passed to the function.- Throws:
ApiException- if the remote call fails
-
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](https://cloud.google.com/functions/quotas#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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CallFunctionRequest request = CallFunctionRequest.newBuilder() .setName(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setData("data3076010") .build(); CallFunctionResponse response = cloudFunctionsServiceClient.callFunction(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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](https://cloud.google.com/functions/quotas#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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { CallFunctionRequest request = CallFunctionRequest.newBuilder() .setName(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setData("data3076010") .build(); ApiFuture<CallFunctionResponse> future = cloudFunctionsServiceClient.callFunctionCallable().futureCall(request); // Do something. CallFunctionResponse response = future.get(); } -
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`
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GenerateUploadUrlRequest request = GenerateUploadUrlRequest.newBuilder() .setParent("parent-995424086") .setKmsKeyName( CryptoKeyName.of("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]") .toString()) .build(); GenerateUploadUrlResponse response = cloudFunctionsServiceClient.generateUploadUrl(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
generateUploadUrlCallable
public final UnaryCallable<GenerateUploadUrlRequest,GenerateUploadUrlResponse> generateUploadUrlCallable()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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GenerateUploadUrlRequest request = 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. GenerateUploadUrlResponse response = future.get(); } -
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-urlsSample 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GenerateDownloadUrlRequest request = GenerateDownloadUrlRequest.newBuilder() .setName("name3373707") .setVersionId(-670497310) .build(); GenerateDownloadUrlResponse response = cloudFunctionsServiceClient.generateDownloadUrl(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
generateDownloadUrlCallable
public final UnaryCallable<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse> generateDownloadUrlCallable()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-urlsSample 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GenerateDownloadUrlRequest request = GenerateDownloadUrlRequest.newBuilder() .setName("name3373707") .setVersionId(-670497310) .build(); ApiFuture<GenerateDownloadUrlResponse> future = cloudFunctionsServiceClient.generateDownloadUrlCallable().futureCall(request); // Do something. GenerateDownloadUrlResponse response = future.get(); } -
setIamPolicy
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Policy response = cloudFunctionsServiceClient.setIamPolicy(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { SetIamPolicyRequest request = 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. Policy response = future.get(); } -
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.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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); Policy response = cloudFunctionsServiceClient.getIamPolicy(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); ApiFuture<Policy> future = cloudFunctionsServiceClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); } -
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.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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); TestIamPermissionsResponse response = cloudFunctionsServiceClient.testIamPermissions(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
testIamPermissionsCallable
public final UnaryCallable<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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); ApiFuture<TestIamPermissionsResponse> future = cloudFunctionsServiceClient.testIamPermissionsCallable().futureCall(request); // Do something. TestIamPermissionsResponse response = future.get(); } -
listLocations
public final CloudFunctionsServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request) 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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : cloudFunctionsServiceClient.listLocations(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listLocationsPagedCallable
public final UnaryCallable<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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = cloudFunctionsServiceClient.listLocationsPagedCallable().futureCall(request); // Do something. for (Location element : future.get().iterateAll()) { // doThingsWith(element); } } -
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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = cloudFunctionsServiceClient.listLocationsCallable().call(request); for (Location element : response.getLocationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-