Class FunctionServiceClient
- java.lang.Object
-
- com.google.cloud.functions.v2alpha.FunctionServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class FunctionServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Google Cloud Functions is used to deploy functions that are executed by Google in response to various events. Data connected with that event is passed to a function as the input data.A **function** is a resource which describes a function that should be executed and how it is triggered.
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { FunctionName name = FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]"); Function response = functionServiceClient.getFunction(name); }
Note: close() needs to be called on the FunctionServiceClient 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 FunctionServiceSettings 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 FunctionServiceSettings functionServiceSettings = FunctionServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); FunctionServiceClient functionServiceClient = FunctionServiceClient.create(functionServiceSettings);
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 FunctionServiceSettings functionServiceSettings = FunctionServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); FunctionServiceClient functionServiceClient = FunctionServiceClient.create(functionServiceSettings);
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 FunctionServiceSettings functionServiceSettings = FunctionServiceSettings.newHttpJsonBuilder().build(); FunctionServiceClient functionServiceClient = FunctionServiceClient.create(functionServiceSettings);
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
FunctionServiceClient.ListFunctionsFixedSizeCollection
static class
FunctionServiceClient.ListFunctionsPage
static class
FunctionServiceClient.ListFunctionsPagedResponse
static class
FunctionServiceClient.ListLocationsFixedSizeCollection
static class
FunctionServiceClient.ListLocationsPage
static class
FunctionServiceClient.ListLocationsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
FunctionServiceClient(FunctionServiceSettings settings)
Constructs an instance of FunctionServiceClient, using the given settings.protected
FunctionServiceClient(FunctionServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static FunctionServiceClient
create()
Constructs an instance of FunctionServiceClient with default settings.static FunctionServiceClient
create(FunctionServiceSettings settings)
Constructs an instance of FunctionServiceClient, using the given settings.static FunctionServiceClient
create(FunctionServiceStub stub)
Constructs an instance of FunctionServiceClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata>
createFunctionAsync(CreateFunctionRequest request)
Creates a new function.com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata>
createFunctionAsync(LocationName parent, Function function, String functionId)
Creates a new function.com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata>
createFunctionAsync(String parent, Function function, String functionId)
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,Function,OperationMetadata>
createFunctionOperationCallable()
Creates a new function.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteFunctionAsync(DeleteFunctionRequest request)
Deletes a function with the given name from the specified project.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteFunctionAsync(FunctionName name)
Deletes a function with the given name from the specified project.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
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,OperationMetadata>
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.Function
getFunction(FunctionName name)
Returns a function with the given name from the requested project.Function
getFunction(GetFunctionRequest request)
Returns a function with the given name from the requested project.Function
getFunction(String name)
Returns a function with the given name from the requested project.com.google.api.gax.rpc.UnaryCallable<GetFunctionRequest,Function>
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 access control policy for a resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.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.FunctionServiceSettings
getSettings()
FunctionServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
FunctionServiceClient.ListFunctionsPagedResponse
listFunctions(ListFunctionsRequest request)
Returns a list of functions that belong to the requested project.FunctionServiceClient.ListFunctionsPagedResponse
listFunctions(LocationName parent)
Returns a list of functions that belong to the requested project.FunctionServiceClient.ListFunctionsPagedResponse
listFunctions(String parent)
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,FunctionServiceClient.ListFunctionsPagedResponse>
listFunctionsPagedCallable()
Returns a list of functions that belong to the requested project.FunctionServiceClient.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,FunctionServiceClient.ListLocationsPagedResponse>
listLocationsPagedCallable()
Lists information about the supported locations for this service.ListRuntimesResponse
listRuntimes(ListRuntimesRequest request)
Returns a list of runtimes that are supported for the requested project.ListRuntimesResponse
listRuntimes(LocationName parent)
Returns a list of runtimes that are supported for the requested project.ListRuntimesResponse
listRuntimes(String parent)
Returns a list of runtimes that are supported for the requested project.com.google.api.gax.rpc.UnaryCallable<ListRuntimesRequest,ListRuntimesResponse>
listRuntimesCallable()
Returns a list of runtimes that are supported for the requested project.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata>
updateFunctionAsync(Function function, com.google.protobuf.FieldMask updateMask)
Updates existing function.com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata>
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,Function,OperationMetadata>
updateFunctionOperationCallable()
Updates existing function.
-
-
-
Constructor Detail
-
FunctionServiceClient
protected FunctionServiceClient(FunctionServiceSettings settings) throws IOException
Constructs an instance of FunctionServiceClient, 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
-
FunctionServiceClient
protected FunctionServiceClient(FunctionServiceStub stub)
-
-
Method Detail
-
create
public static final FunctionServiceClient create() throws IOException
Constructs an instance of FunctionServiceClient with default settings.- Throws:
IOException
-
create
public static final FunctionServiceClient create(FunctionServiceSettings settings) throws IOException
Constructs an instance of FunctionServiceClient, 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 FunctionServiceClient create(FunctionServiceStub stub)
Constructs an instance of FunctionServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(FunctionServiceSettings).
-
getSettings
public final FunctionServiceSettings getSettings()
-
getStub
public FunctionServiceStub 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.
-
getFunction
public final Function getFunction(FunctionName 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { FunctionName name = FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]"); Function response = functionServiceClient.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 Function 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { String name = FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString(); Function response = functionServiceClient.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 Function 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { GetFunctionRequest request = GetFunctionRequest.newBuilder() .setName(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); Function response = functionServiceClient.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,Function> 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { GetFunctionRequest request = GetFunctionRequest.newBuilder() .setName(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); ApiFuture<Function> future = functionServiceClient.getFunctionCallable().futureCall(request); // Do something. Function response = future.get(); }
-
listFunctions
public final FunctionServiceClient.ListFunctionsPagedResponse listFunctions(LocationName parent)
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (Function element : functionServiceClient.listFunctions(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFunctions
public final FunctionServiceClient.ListFunctionsPagedResponse listFunctions(String parent)
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (Function element : functionServiceClient.listFunctions(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFunctions
public final FunctionServiceClient.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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { ListFunctionsRequest request = ListFunctionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setOrderBy("orderBy-1207110587") .build(); for (Function element : functionServiceClient.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,FunctionServiceClient.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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { ListFunctionsRequest request = ListFunctionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setOrderBy("orderBy-1207110587") .build(); ApiFuture<Function> future = functionServiceClient.listFunctionsPagedCallable().futureCall(request); // Do something. for (Function 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { ListFunctionsRequest request = ListFunctionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setOrderBy("orderBy-1207110587") .build(); while (true) { ListFunctionsResponse response = functionServiceClient.listFunctionsCallable().call(request); for (Function element : response.getFunctionsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
createFunctionAsync
public final com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata> createFunctionAsync(LocationName parent, Function function, String functionId)
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); Function function = Function.newBuilder().build(); String functionId = "functionId-62789869"; Function response = functionServiceClient.createFunctionAsync(parent, function, functionId).get(); }
- Parameters:
parent
- Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`function
- Required. Function to be created.functionId
- The ID to use for the function, which will become the final component of the function's resource name.This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createFunctionAsync
public final com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata> createFunctionAsync(String parent, Function function, String functionId)
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); Function function = Function.newBuilder().build(); String functionId = "functionId-62789869"; Function response = functionServiceClient.createFunctionAsync(parent, function, functionId).get(); }
- Parameters:
parent
- Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`function
- Required. Function to be created.functionId
- The ID to use for the function, which will become the final component of the function's resource name.This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createFunctionAsync
public final com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata> 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { CreateFunctionRequest request = CreateFunctionRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFunction(Function.newBuilder().build()) .setFunctionId("functionId-62789869") .build(); Function response = functionServiceClient.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,Function,OperationMetadata> createFunctionOperationCallable()
Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { CreateFunctionRequest request = CreateFunctionRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFunction(Function.newBuilder().build()) .setFunctionId("functionId-62789869") .build(); OperationFuture<Function, OperationMetadata> future = functionServiceClient.createFunctionOperationCallable().futureCall(request); // Do something. Function 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 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { CreateFunctionRequest request = CreateFunctionRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFunction(Function.newBuilder().build()) .setFunctionId("functionId-62789869") .build(); ApiFuture<Operation> future = functionServiceClient.createFunctionCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
updateFunctionAsync
public final com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata> updateFunctionAsync(Function function, com.google.protobuf.FieldMask updateMask)
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { Function function = Function.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Function response = functionServiceClient.updateFunctionAsync(function, updateMask).get(); }
- Parameters:
function
- Required. New version of the function.updateMask
- The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateFunctionAsync
public final com.google.api.gax.longrunning.OperationFuture<Function,OperationMetadata> 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { UpdateFunctionRequest request = UpdateFunctionRequest.newBuilder() .setFunction(Function.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Function response = functionServiceClient.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,Function,OperationMetadata> 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { UpdateFunctionRequest request = UpdateFunctionRequest.newBuilder() .setFunction(Function.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); OperationFuture<Function, OperationMetadata> future = functionServiceClient.updateFunctionOperationCallable().futureCall(request); // Do something. Function 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { UpdateFunctionRequest request = UpdateFunctionRequest.newBuilder() .setFunction(Function.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Operation> future = functionServiceClient.updateFunctionCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteFunctionAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteFunctionAsync(FunctionName 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { FunctionName name = FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]"); functionServiceClient.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,OperationMetadata> 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { String name = FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString(); functionServiceClient.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,OperationMetadata> 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { DeleteFunctionRequest request = DeleteFunctionRequest.newBuilder() .setName(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); functionServiceClient.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,OperationMetadata> deleteFunctionOperationCallable()
Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { DeleteFunctionRequest request = DeleteFunctionRequest.newBuilder() .setName(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); OperationFuture<Empty, OperationMetadata> future = functionServiceClient.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 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { DeleteFunctionRequest request = DeleteFunctionRequest.newBuilder() .setName(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); ApiFuture<Operation> future = functionServiceClient.deleteFunctionCallable().futureCall(request); // Do something. 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.
- 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`
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { GenerateUploadUrlRequest request = GenerateUploadUrlRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setKmsKeyName( CryptoKeyName.of("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]") .toString()) .build(); GenerateUploadUrlResponse response = functionServiceClient.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.
- 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`
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { GenerateUploadUrlRequest request = GenerateUploadUrlRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setKmsKeyName( CryptoKeyName.of("[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]") .toString()) .build(); ApiFuture<GenerateUploadUrlResponse> future = functionServiceClient.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 should be used within 30 minutes of 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { GenerateDownloadUrlRequest request = GenerateDownloadUrlRequest.newBuilder() .setName(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); GenerateDownloadUrlResponse response = functionServiceClient.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 should be used within 30 minutes of 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { GenerateDownloadUrlRequest request = GenerateDownloadUrlRequest.newBuilder() .setName(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .build(); ApiFuture<GenerateDownloadUrlResponse> future = functionServiceClient.generateDownloadUrlCallable().futureCall(request); // Do something. GenerateDownloadUrlResponse response = future.get(); }
-
listRuntimes
public final ListRuntimesResponse listRuntimes(LocationName parent)
Returns a list of runtimes that are supported for 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); ListRuntimesResponse response = functionServiceClient.listRuntimes(parent); }
- Parameters:
parent
- Required. The project and location from which the runtimes should be listed, specified in the format `projects/*/locations/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRuntimes
public final ListRuntimesResponse listRuntimes(String parent)
Returns a list of runtimes that are supported for 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); ListRuntimesResponse response = functionServiceClient.listRuntimes(parent); }
- Parameters:
parent
- Required. The project and location from which the runtimes should be listed, specified in the format `projects/*/locations/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRuntimes
public final ListRuntimesResponse listRuntimes(ListRuntimesRequest request)
Returns a list of runtimes that are supported for 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { ListRuntimesRequest request = ListRuntimesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFilter("filter-1274492040") .build(); ListRuntimesResponse response = functionServiceClient.listRuntimes(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
-
listRuntimesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListRuntimesRequest,ListRuntimesResponse> listRuntimesCallable()
Returns a list of runtimes that are supported for 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { ListRuntimesRequest request = ListRuntimesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFilter("filter-1274492040") .build(); ApiFuture<ListRuntimesResponse> future = functionServiceClient.listRuntimesCallable().futureCall(request); // Do something. ListRuntimesResponse response = future.get(); }
-
listLocations
public final FunctionServiceClient.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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : functionServiceClient.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,FunctionServiceClient.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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = functionServiceClient.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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = functionServiceClient.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; } } }
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Policy response = functionServiceClient.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 access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Policy> future = functionServiceClient.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 access control policy for a resource. Returns an empty policyif the resource 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); Policy response = functionServiceClient.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 access control policy for a resource. Returns an empty policyif the resource 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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); ApiFuture<Policy> future = functionServiceClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); TestIamPermissionsResponse response = functionServiceClient.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()
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
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 (FunctionServiceClient functionServiceClient = FunctionServiceClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(FunctionName.of("[PROJECT]", "[LOCATION]", "[FUNCTION]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); ApiFuture<TestIamPermissionsResponse> future = functionServiceClient.testIamPermissionsCallable().futureCall(request); // Do something. TestIamPermissionsResponse response = future.get(); }
-
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
-
-