Class CmekConfigServiceClient (0.60.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing CMEK related tasks

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   CmekConfigName name = CmekConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]");
   CmekConfig response = cmekConfigServiceClient.getCmekConfig(name);
 }
 

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

Methods
Method Description Method Variants

UpdateCmekConfig

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateCmekConfigAsync(UpdateCmekConfigRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateCmekConfigAsync(CmekConfig config)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateCmekConfigOperationCallable()

  • updateCmekConfigCallable()

GetCmekConfig

Gets the CmekConfig.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCmekConfig(GetCmekConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCmekConfig(CmekConfigName name)

  • getCmekConfig(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCmekConfigCallable()

ListCmekConfigs

Lists all the CmekConfigs with the project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listCmekConfigs(ListCmekConfigsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listCmekConfigs(LocationName parent)

  • listCmekConfigs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listCmekConfigsCallable()

DeleteCmekConfig

De-provisions a CmekConfig.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteCmekConfigAsync(DeleteCmekConfigRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteCmekConfigAsync(CmekConfigName name)

  • deleteCmekConfigAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteCmekConfigOperationCallable()

  • deleteCmekConfigCallable()

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 CmekConfigServiceSettings 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
 CmekConfigServiceSettings cmekConfigServiceSettings =
     CmekConfigServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CmekConfigServiceClient cmekConfigServiceClient =
     CmekConfigServiceClient.create(cmekConfigServiceSettings);
 

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
 CmekConfigServiceSettings cmekConfigServiceSettings =
     CmekConfigServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CmekConfigServiceClient cmekConfigServiceClient =
     CmekConfigServiceClient.create(cmekConfigServiceSettings);
 

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
 CmekConfigServiceSettings cmekConfigServiceSettings =
     CmekConfigServiceSettings.newHttpJsonBuilder().build();
 CmekConfigServiceClient cmekConfigServiceClient =
     CmekConfigServiceClient.create(cmekConfigServiceSettings);
 

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

Inheritance

java.lang.Object > CmekConfigServiceClient

Static Methods

create()

public static final CmekConfigServiceClient create()

Constructs an instance of CmekConfigServiceClient with default settings.

Returns
Type Description
CmekConfigServiceClient
Exceptions
Type Description
IOException

create(CmekConfigServiceSettings settings)

public static final CmekConfigServiceClient create(CmekConfigServiceSettings settings)

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

Parameter
Name Description
settings CmekConfigServiceSettings
Returns
Type Description
CmekConfigServiceClient
Exceptions
Type Description
IOException

create(CmekConfigServiceStub stub)

public static final CmekConfigServiceClient create(CmekConfigServiceStub stub)

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

Parameter
Name Description
stub CmekConfigServiceStub
Returns
Type Description
CmekConfigServiceClient

Constructors

CmekConfigServiceClient(CmekConfigServiceSettings settings)

protected CmekConfigServiceClient(CmekConfigServiceSettings settings)

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

Parameter
Name Description
settings CmekConfigServiceSettings

CmekConfigServiceClient(CmekConfigServiceStub stub)

protected CmekConfigServiceClient(CmekConfigServiceStub stub)
Parameter
Name Description
stub CmekConfigServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

deleteCmekConfigAsync(CmekConfigName name)

public final OperationFuture<Empty,DeleteCmekConfigMetadata> deleteCmekConfigAsync(CmekConfigName name)

De-provisions a CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   CmekConfigName name =
       CmekConfigName.ofProjectLocationCmekConfigName(
           "[PROJECT]", "[LOCATION]", "[CMEK_CONFIG]");
   cmekConfigServiceClient.deleteCmekConfigAsync(name).get();
 }
 
Parameter
Name Description
name CmekConfigName

Required. The resource name of the CmekConfig to delete, such as projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

Returns
Type Description
OperationFuture<Empty,DeleteCmekConfigMetadata>

deleteCmekConfigAsync(DeleteCmekConfigRequest request)

public final OperationFuture<Empty,DeleteCmekConfigMetadata> deleteCmekConfigAsync(DeleteCmekConfigRequest request)

De-provisions a CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   DeleteCmekConfigRequest request =
       DeleteCmekConfigRequest.newBuilder()
           .setName(
               CmekConfigName.ofProjectLocationCmekConfigName(
                       "[PROJECT]", "[LOCATION]", "[CMEK_CONFIG]")
                   .toString())
           .build();
   cmekConfigServiceClient.deleteCmekConfigAsync(request).get();
 }
 
Parameter
Name Description
request DeleteCmekConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,DeleteCmekConfigMetadata>

deleteCmekConfigAsync(String name)

public final OperationFuture<Empty,DeleteCmekConfigMetadata> deleteCmekConfigAsync(String name)

De-provisions a CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   String name = CmekConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString();
   cmekConfigServiceClient.deleteCmekConfigAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the CmekConfig to delete, such as projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

Returns
Type Description
OperationFuture<Empty,DeleteCmekConfigMetadata>

deleteCmekConfigCallable()

public final UnaryCallable<DeleteCmekConfigRequest,Operation> deleteCmekConfigCallable()

De-provisions a CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   DeleteCmekConfigRequest request =
       DeleteCmekConfigRequest.newBuilder()
           .setName(
               CmekConfigName.ofProjectLocationCmekConfigName(
                       "[PROJECT]", "[LOCATION]", "[CMEK_CONFIG]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       cmekConfigServiceClient.deleteCmekConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteCmekConfigRequest,Operation>

deleteCmekConfigOperationCallable()

public final OperationCallable<DeleteCmekConfigRequest,Empty,DeleteCmekConfigMetadata> deleteCmekConfigOperationCallable()

De-provisions a CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   DeleteCmekConfigRequest request =
       DeleteCmekConfigRequest.newBuilder()
           .setName(
               CmekConfigName.ofProjectLocationCmekConfigName(
                       "[PROJECT]", "[LOCATION]", "[CMEK_CONFIG]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteCmekConfigMetadata> future =
       cmekConfigServiceClient.deleteCmekConfigOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteCmekConfigRequest,Empty,DeleteCmekConfigMetadata>

getCmekConfig(CmekConfigName name)

public final CmekConfig getCmekConfig(CmekConfigName name)

Gets the CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   CmekConfigName name = CmekConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]");
   CmekConfig response = cmekConfigServiceClient.getCmekConfig(name);
 }
 
Parameter
Name Description
name CmekConfigName

Required. Resource name of CmekConfig, such as projects/*/locations/*/cmekConfig or projects/*/locations/*/cmekConfigs/*.

If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns
Type Description
CmekConfig

getCmekConfig(GetCmekConfigRequest request)

public final CmekConfig getCmekConfig(GetCmekConfigRequest request)

Gets the CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   GetCmekConfigRequest request =
       GetCmekConfigRequest.newBuilder()
           .setName(CmekConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString())
           .build();
   CmekConfig response = cmekConfigServiceClient.getCmekConfig(request);
 }
 
Parameter
Name Description
request GetCmekConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CmekConfig

getCmekConfig(String name)

public final CmekConfig getCmekConfig(String name)

Gets the CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   String name = CmekConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString();
   CmekConfig response = cmekConfigServiceClient.getCmekConfig(name);
 }
 
Parameter
Name Description
name String

Required. Resource name of CmekConfig, such as projects/*/locations/*/cmekConfig or projects/*/locations/*/cmekConfigs/*.

If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns
Type Description
CmekConfig

getCmekConfigCallable()

public final UnaryCallable<GetCmekConfigRequest,CmekConfig> getCmekConfigCallable()

Gets the CmekConfig.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   GetCmekConfigRequest request =
       GetCmekConfigRequest.newBuilder()
           .setName(CmekConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<CmekConfig> future =
       cmekConfigServiceClient.getCmekConfigCallable().futureCall(request);
   // Do something.
   CmekConfig response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetCmekConfigRequest,CmekConfig>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns
Type Description
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type Description
OperationsClient

getSettings()

public final CmekConfigServiceSettings getSettings()
Returns
Type Description
CmekConfigServiceSettings

getStub()

public CmekConfigServiceStub getStub()
Returns
Type Description
CmekConfigServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listCmekConfigs(ListCmekConfigsRequest request)

public final ListCmekConfigsResponse listCmekConfigs(ListCmekConfigsRequest request)

Lists all the CmekConfigs with the 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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   ListCmekConfigsRequest request =
       ListCmekConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ListCmekConfigsResponse response = cmekConfigServiceClient.listCmekConfigs(request);
 }
 
Parameter
Name Description
request ListCmekConfigsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ListCmekConfigsResponse

listCmekConfigs(LocationName parent)

public final ListCmekConfigsResponse listCmekConfigs(LocationName parent)

Lists all the CmekConfigs with the 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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListCmekConfigsResponse response = cmekConfigServiceClient.listCmekConfigs(parent);
 }
 
Parameter
Name Description
parent LocationName

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.

Returns
Type Description
ListCmekConfigsResponse

listCmekConfigs(String parent)

public final ListCmekConfigsResponse listCmekConfigs(String parent)

Lists all the CmekConfigs with the 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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ListCmekConfigsResponse response = cmekConfigServiceClient.listCmekConfigs(parent);
 }
 
Parameter
Name Description
parent String

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.

Returns
Type Description
ListCmekConfigsResponse

listCmekConfigsCallable()

public final UnaryCallable<ListCmekConfigsRequest,ListCmekConfigsResponse> listCmekConfigsCallable()

Lists all the CmekConfigs with the 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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   ListCmekConfigsRequest request =
       ListCmekConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<ListCmekConfigsResponse> future =
       cmekConfigServiceClient.listCmekConfigsCallable().futureCall(request);
   // Do something.
   ListCmekConfigsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ListCmekConfigsRequest,ListCmekConfigsResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateCmekConfigAsync(CmekConfig config)

public final OperationFuture<CmekConfig,UpdateCmekConfigMetadata> updateCmekConfigAsync(CmekConfig config)

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   CmekConfig config = CmekConfig.newBuilder().build();
   CmekConfig response = cmekConfigServiceClient.updateCmekConfigAsync(config).get();
 }
 
Parameter
Name Description
config CmekConfig

Required. The CmekConfig resource.

Returns
Type Description
OperationFuture<CmekConfig,UpdateCmekConfigMetadata>

updateCmekConfigAsync(UpdateCmekConfigRequest request)

public final OperationFuture<CmekConfig,UpdateCmekConfigMetadata> updateCmekConfigAsync(UpdateCmekConfigRequest request)

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   UpdateCmekConfigRequest request =
       UpdateCmekConfigRequest.newBuilder()
           .setConfig(CmekConfig.newBuilder().build())
           .setSetDefault(true)
           .build();
   CmekConfig response = cmekConfigServiceClient.updateCmekConfigAsync(request).get();
 }
 
Parameter
Name Description
request UpdateCmekConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<CmekConfig,UpdateCmekConfigMetadata>

updateCmekConfigCallable()

public final UnaryCallable<UpdateCmekConfigRequest,Operation> updateCmekConfigCallable()

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   UpdateCmekConfigRequest request =
       UpdateCmekConfigRequest.newBuilder()
           .setConfig(CmekConfig.newBuilder().build())
           .setSetDefault(true)
           .build();
   ApiFuture<Operation> future =
       cmekConfigServiceClient.updateCmekConfigCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateCmekConfigRequest,Operation>

updateCmekConfigOperationCallable()

public final OperationCallable<UpdateCmekConfigRequest,CmekConfig,UpdateCmekConfigMetadata> updateCmekConfigOperationCallable()

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
   UpdateCmekConfigRequest request =
       UpdateCmekConfigRequest.newBuilder()
           .setConfig(CmekConfig.newBuilder().build())
           .setSetDefault(true)
           .build();
   OperationFuture<CmekConfig, UpdateCmekConfigMetadata> future =
       cmekConfigServiceClient.updateCmekConfigOperationCallable().futureCall(request);
   // Do something.
   CmekConfig response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateCmekConfigRequest,CmekConfig,UpdateCmekConfigMetadata>