Class CloudFunctionsServiceClient
- java.lang.Object
-
- com.google.cloud.functions.v1.CloudFunctionsServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class CloudFunctionsServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
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_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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns 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 Classes Modifier and Type Class Description static class
CloudFunctionsServiceClient.ListFunctionsFixedSizeCollection
static class
CloudFunctionsServiceClient.ListFunctionsPage
static class
CloudFunctionsServiceClient.ListFunctionsPagedResponse
static class
CloudFunctionsServiceClient.ListLocationsFixedSizeCollection
static class
CloudFunctionsServiceClient.ListLocationsPage
static class
CloudFunctionsServiceClient.ListLocationsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
CloudFunctionsServiceClient(CloudFunctionsServiceSettings settings)
Constructs an instance of CloudFunctionsServiceClient, using the given settings.protected
CloudFunctionsServiceClient(CloudFunctionsServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
CallFunctionResponse
callFunction(CallFunctionRequest request)
Synchronously invokes a deployed Cloud Function.CallFunctionResponse
callFunction(CloudFunctionName name, String data)
Synchronously invokes a deployed Cloud Function.CallFunctionResponse
callFunction(String name, String data)
Synchronously invokes a deployed Cloud Function.com.google.api.gax.rpc.UnaryCallable<CallFunctionRequest,CallFunctionResponse>
callFunctionCallable()
Synchronously invokes a deployed Cloud Function.void
close()
static CloudFunctionsServiceClient
create()
Constructs an instance of CloudFunctionsServiceClient with default settings.static CloudFunctionsServiceClient
create(CloudFunctionsServiceSettings settings)
Constructs an instance of CloudFunctionsServiceClient, using the given settings.static CloudFunctionsServiceClient
create(CloudFunctionsServiceStub stub)
Constructs an instance of CloudFunctionsServiceClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<CloudFunction,OperationMetadataV1>
createFunctionAsync(CreateFunctionRequest request)
Creates a new function.com.google.api.gax.longrunning.OperationFuture<CloudFunction,OperationMetadataV1>
createFunctionAsync(LocationName location, CloudFunction function)
Creates a new function.com.google.api.gax.longrunning.OperationFuture<CloudFunction,OperationMetadataV1>
createFunctionAsync(String location, CloudFunction function)
Creates a new function.com.google.api.gax.rpc.UnaryCallable<CreateFunctionRequest,com.google.longrunning.Operation>
createFunctionCallable()
Creates a new function.com.google.api.gax.rpc.OperationCallable<CreateFunctionRequest,CloudFunction,OperationMetadataV1>
createFunctionOperationCallable()
Creates a new function.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadataV1>
deleteFunctionAsync(CloudFunctionName name)
Deletes a function with the given name from the specified project.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadataV1>
deleteFunctionAsync(DeleteFunctionRequest request)
Deletes a function with the given name from the specified project.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadataV1>
deleteFunctionAsync(String name)
Deletes a function with the given name from the specified project.com.google.api.gax.rpc.UnaryCallable<DeleteFunctionRequest,com.google.longrunning.Operation>
deleteFunctionCallable()
Deletes a function with the given name from the specified project.com.google.api.gax.rpc.OperationCallable<DeleteFunctionRequest,com.google.protobuf.Empty,OperationMetadataV1>
deleteFunctionOperationCallable()
Deletes a function with the given name from the specified project.GenerateDownloadUrlResponse
generateDownloadUrl(GenerateDownloadUrlRequest request)
Returns a signed URL for downloading deployed function source code.com.google.api.gax.rpc.UnaryCallable<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>
generateDownloadUrlCallable()
Returns a signed URL for downloading deployed function source code.GenerateUploadUrlResponse
generateUploadUrl(GenerateUploadUrlRequest request)
Returns a signed URL for uploading a function source code.com.google.api.gax.rpc.UnaryCallable<GenerateUploadUrlRequest,GenerateUploadUrlResponse>
generateUploadUrlCallable()
Returns a signed URL for uploading a function source code.CloudFunction
getFunction(CloudFunctionName name)
Returns a function with the given name from the requested project.CloudFunction
getFunction(GetFunctionRequest request)
Returns a function with the given name from the requested project.CloudFunction
getFunction(String name)
Returns a function with the given name from the requested project.com.google.api.gax.rpc.UnaryCallable<GetFunctionRequest,CloudFunction>
getFunctionCallable()
Returns a function with the given name from the requested project.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.iam.v1.Policy
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the IAM access control policy for a function.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicyCallable()
Gets the IAM access control policy for a function.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.CloudFunctionsServiceSettings
getSettings()
CloudFunctionsServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
CloudFunctionsServiceClient.ListFunctionsPagedResponse
listFunctions(ListFunctionsRequest request)
Returns a list of functions that belong to the requested project.com.google.api.gax.rpc.UnaryCallable<ListFunctionsRequest,ListFunctionsResponse>
listFunctionsCallable()
Returns a list of functions that belong to the requested project.com.google.api.gax.rpc.UnaryCallable<ListFunctionsRequest,CloudFunctionsServiceClient.ListFunctionsPagedResponse>
listFunctionsPagedCallable()
Returns a list of functions that belong to the requested project.CloudFunctionsServiceClient.ListLocationsPagedResponse
listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>
listLocationsCallable()
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,CloudFunctionsServiceClient.ListLocationsPagedResponse>
listLocationsPagedCallable()
Lists information about the supported locations for this service.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the IAM access control policy on the specified function.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicyCallable()
Sets the IAM access control policy on the specified function.void
shutdown()
void
shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Tests the specified permissions against the IAM access control policy for a function.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsCallable()
Tests the specified permissions against the IAM access control policy for a function.com.google.api.gax.longrunning.OperationFuture<CloudFunction,OperationMetadataV1>
updateFunctionAsync(CloudFunction function)
Updates existing function.com.google.api.gax.longrunning.OperationFuture<CloudFunction,OperationMetadataV1>
updateFunctionAsync(UpdateFunctionRequest request)
Updates existing function.com.google.api.gax.rpc.UnaryCallable<UpdateFunctionRequest,com.google.longrunning.Operation>
updateFunctionCallable()
Updates existing function.com.google.api.gax.rpc.OperationCallable<UpdateFunctionRequest,CloudFunction,OperationMetadataV1>
updateFunctionOperationCallable()
Updates existing function.
-
-
-
Constructor Detail
-
CloudFunctionsServiceClient
protected CloudFunctionsServiceClient(CloudFunctionsServiceSettings settings) throws IOException
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
protected CloudFunctionsServiceClient(CloudFunctionsServiceStub stub)
-
-
Method Detail
-
create
public static final CloudFunctionsServiceClient create() throws IOException
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
public static final CloudFunctionsServiceClient create(CloudFunctionsServiceStub stub)
Constructs an instance of CloudFunctionsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudFunctionsServiceSettings).
-
getSettings
public final CloudFunctionsServiceSettings getSettings()
-
getStub
public CloudFunctionsServiceStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient 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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFunctionsPagedCallable
public final com.google.api.gax.rpc.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
public final com.google.api.gax.rpc.UnaryCallable<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_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
public final CloudFunction getFunction(CloudFunctionName name)
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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getFunction
public final CloudFunction getFunction(String name)
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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getFunction
public final CloudFunction getFunction(GetFunctionRequest request)
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()) .build(); CloudFunction response = cloudFunctionsServiceClient.getFunction(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getFunctionCallable
public final com.google.api.gax.rpc.UnaryCallable<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_library try (CloudFunctionsServiceClient cloudFunctionsServiceClient = CloudFunctionsServiceClient.create()) { GetFunctionRequest request = GetFunctionRequest.newBuilder() .setName(CloudFunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); ApiFuture<CloudFunction> future = cloudFunctionsServiceClient.getFunctionCallable().futureCall(request); // Do something. CloudFunction response = future.get(); }
-
createFunctionAsync
public final com.google.api.gax.longrunning.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 returns an `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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createFunctionAsync
public final com.google.api.gax.longrunning.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 returns an `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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createFunctionAsync
public final com.google.api.gax.longrunning.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 returns an `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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createFunctionOperationCallable
public final com.google.api.gax.rpc.OperationCallable<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 returns an `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
public final com.google.api.gax.rpc.UnaryCallable<CreateFunctionRequest,com.google.longrunning.Operation> createFunctionCallable()
Creates a new function. If a function with the given name already exists in the specified project, the long running operation returns an `ALREADY_EXISTS` error.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 com.google.api.gax.longrunning.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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateFunctionAsync
public final com.google.api.gax.longrunning.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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateFunctionOperationCallable
public final com.google.api.gax.rpc.OperationCallable<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_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
public final com.google.api.gax.rpc.UnaryCallable<UpdateFunctionRequest,com.google.longrunning.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_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 com.google.api.gax.longrunning.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 is 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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteFunctionAsync
public final com.google.api.gax.longrunning.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 is 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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteFunctionAsync
public final com.google.api.gax.longrunning.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 is 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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteFunctionOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteFunctionRequest,com.google.protobuf.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 is 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
public final com.google.api.gax.rpc.UnaryCallable<DeleteFunctionRequest,com.google.longrunning.Operation> deleteFunctionCallable()
Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger is updated to remove this function.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
public final CallFunctionResponse callFunction(CloudFunctionName name, String data)
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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
callFunction
public final CallFunctionResponse callFunction(String name, String data)
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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
callFunction
public final CallFunctionResponse callFunction(CallFunctionRequest request)
Synchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits, refer to [Rate Limits](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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
callFunctionCallable
public final com.google.api.gax.rpc.UnaryCallable<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](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
public final GenerateUploadUrlResponse generateUploadUrl(GenerateUploadUrlRequest request)
Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code.When uploading source code to the generated signed URL, please follow these restrictions:
- Source file type should be a zip file.
- Source file size should not exceed 100MB limit.
- No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL.
When making an HTTP PUT request, these two headers must be specified:
- `content-type: application/zip`
- `x-goog-content-length-range: 0,104857600`
And this header must NOT be specified:
- `Authorization: Bearer YOUR_TOKEN`
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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
generateUploadUrlCallable
public final com.google.api.gax.rpc.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 an HTTP PUT request, these two headers must be specified:
- `content-type: application/zip`
- `x-goog-content-length-range: 0,104857600`
And this header must NOT be specified:
- `Authorization: Bearer YOUR_TOKEN`
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
public final GenerateDownloadUrlResponse generateDownloadUrl(GenerateDownloadUrlRequest request)
Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and must be used within minutes after generation. For more information about the signed URL usage, see: https://cloud.google.com/storage/docs/access-control/signed-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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
generateDownloadUrlCallable
public final com.google.api.gax.rpc.UnaryCallable<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse> generateDownloadUrlCallable()
Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and must be used within minutes after generation. For more information about the signed URL usage, see: https://cloud.google.com/storage/docs/access-control/signed-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
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.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_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
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the IAM access control policy for a function. Returns an empty policy if the function exists and does not have a policy set.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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.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_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
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Tests the specified permissions against the IAM access control policy for a function. If the function does not exist, this returns an empty set of permissions, not a NOT_FOUND error.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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
Tests the specified permissions against the IAM access control policy for a function. If the function does not exist, this returns an empty set of permissions, not a NOT_FOUND error.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(com.google.cloud.location.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:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listLocationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.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
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.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_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:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-