Class EncryptionSpecServiceClient (4.57.0)

Service Description: Manages encryption spec settings for Dialogflow and Agent Assist.

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   EncryptionSpecName name = EncryptionSpecName.of("[PROJECT]", "[LOCATION]");
   EncryptionSpec response = encryptionSpecServiceClient.getEncryptionSpec(name);
 }

Note: close() needs to be called on the EncryptionSpecServiceClient 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
GetEncryptionSpec	Gets location-level encryption key specification.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getEncryptionSpec(GetEncryptionSpecRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getEncryptionSpec(EncryptionSpecName name) getEncryptionSpec(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. getEncryptionSpecCallable()
InitializeEncryptionSpec	Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.	Request object method variants only take one parameter, a request object, which must be constructed before the call. initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. initializeEncryptionSpecAsync(EncryptionSpec encryptionSpec) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. initializeEncryptionSpecOperationCallable() initializeEncryptionSpecCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 EncryptionSpecServiceSettings 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
 EncryptionSpecServiceSettings encryptionSpecServiceSettings =
     EncryptionSpecServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create(encryptionSpecServiceSettings);

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
 EncryptionSpecServiceSettings encryptionSpecServiceSettings =
     EncryptionSpecServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create(encryptionSpecServiceSettings);

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
 EncryptionSpecServiceSettings encryptionSpecServiceSettings =
     EncryptionSpecServiceSettings.newHttpJsonBuilder().build();
 EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create(encryptionSpecServiceSettings);

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

Inheritance

java.lang.Object > EncryptionSpecServiceClient

Static Methods

create()

public static final EncryptionSpecServiceClient create()

Constructs an instance of EncryptionSpecServiceClient with default settings.

Returns
Type	Description
`EncryptionSpecServiceClient`

Exceptions
Type	Description
`IOException`

create(EncryptionSpecServiceSettings settings)

public static final EncryptionSpecServiceClient create(EncryptionSpecServiceSettings settings)

Constructs an instance of EncryptionSpecServiceClient, 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`	`EncryptionSpecServiceSettings`

Returns
Type	Description
`EncryptionSpecServiceClient`

Exceptions
Type	Description
`IOException`

create(EncryptionSpecServiceStub stub)

public static final EncryptionSpecServiceClient create(EncryptionSpecServiceStub stub)

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

Parameter
Name	Description
`stub`	`EncryptionSpecServiceStub`

Returns
Type	Description
`EncryptionSpecServiceClient`

Constructors

EncryptionSpecServiceClient(EncryptionSpecServiceSettings settings)

protected EncryptionSpecServiceClient(EncryptionSpecServiceSettings settings)

Constructs an instance of EncryptionSpecServiceClient, 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`	`EncryptionSpecServiceSettings`

EncryptionSpecServiceClient(EncryptionSpecServiceStub stub)

protected EncryptionSpecServiceClient(EncryptionSpecServiceStub stub)

Parameter
Name	Description
`stub`	`EncryptionSpecServiceStub`

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()

getEncryptionSpec(EncryptionSpecName name)

public final EncryptionSpec getEncryptionSpec(EncryptionSpecName name)

Gets location-level encryption key specification.

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   EncryptionSpecName name = EncryptionSpecName.of("[PROJECT]", "[LOCATION]");
   EncryptionSpec response = encryptionSpecServiceClient.getEncryptionSpec(name);
 }

Parameter
Name	Description
`name`	`EncryptionSpecName` Required. The name of the encryption spec resource to get.

Returns
Type	Description
`EncryptionSpec`

getEncryptionSpec(GetEncryptionSpecRequest request)

public final EncryptionSpec getEncryptionSpec(GetEncryptionSpecRequest request)

Gets location-level encryption key specification.

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   GetEncryptionSpecRequest request =
       GetEncryptionSpecRequest.newBuilder()
           .setName(EncryptionSpecName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   EncryptionSpec response = encryptionSpecServiceClient.getEncryptionSpec(request);
 }

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

Returns
Type	Description
`EncryptionSpec`

getEncryptionSpec(String name)

public final EncryptionSpec getEncryptionSpec(String name)

Gets location-level encryption key specification.

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   String name = EncryptionSpecName.of("[PROJECT]", "[LOCATION]").toString();
   EncryptionSpec response = encryptionSpecServiceClient.getEncryptionSpec(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the encryption spec resource to get.

Returns
Type	Description
`EncryptionSpec`

getEncryptionSpecCallable()

public final UnaryCallable<GetEncryptionSpecRequest,EncryptionSpec> getEncryptionSpecCallable()

Gets location-level encryption key specification.

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   GetEncryptionSpecRequest request =
       GetEncryptionSpecRequest.newBuilder()
           .setName(EncryptionSpecName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<EncryptionSpec> future =
       encryptionSpecServiceClient.getEncryptionSpecCallable().futureCall(request);
   // Do something.
   EncryptionSpec response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetEncryptionSpecRequest,EncryptionSpec>`

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`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a 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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = encryptionSpecServiceClient.getLocation(request);
 }

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

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a 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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       encryptionSpecServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

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 EncryptionSpecServiceSettings getSettings()

Returns
Type	Description
`EncryptionSpecServiceSettings`

getStub()

public EncryptionSpecServiceStub getStub()

Returns
Type	Description
`EncryptionSpecServiceStub`

initializeEncryptionSpecAsync(EncryptionSpec encryptionSpec)

public final OperationFuture<InitializeEncryptionSpecResponse,InitializeEncryptionSpecMetadata> initializeEncryptionSpecAsync(EncryptionSpec encryptionSpec)

Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   EncryptionSpec encryptionSpec = EncryptionSpec.newBuilder().build();
   InitializeEncryptionSpecResponse response =
       encryptionSpecServiceClient.initializeEncryptionSpecAsync(encryptionSpec).get();
 }

Parameter
Name	Description
`encryptionSpec`	`EncryptionSpec` Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced.

Returns
Type	Description
`OperationFuture<InitializeEncryptionSpecResponse,InitializeEncryptionSpecMetadata>`

initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest request)

public final OperationFuture<InitializeEncryptionSpecResponse,InitializeEncryptionSpecMetadata> initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest request)

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   InitializeEncryptionSpecRequest request =
       InitializeEncryptionSpecRequest.newBuilder()
           .setEncryptionSpec(EncryptionSpec.newBuilder().build())
           .build();
   InitializeEncryptionSpecResponse response =
       encryptionSpecServiceClient.initializeEncryptionSpecAsync(request).get();
 }

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

Returns
Type	Description
`OperationFuture<InitializeEncryptionSpecResponse,InitializeEncryptionSpecMetadata>`

initializeEncryptionSpecCallable()

public final UnaryCallable<InitializeEncryptionSpecRequest,Operation> initializeEncryptionSpecCallable()

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   InitializeEncryptionSpecRequest request =
       InitializeEncryptionSpecRequest.newBuilder()
           .setEncryptionSpec(EncryptionSpec.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       encryptionSpecServiceClient.initializeEncryptionSpecCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<InitializeEncryptionSpecRequest,Operation>`

initializeEncryptionSpecOperationCallable()

public final OperationCallable<InitializeEncryptionSpecRequest,InitializeEncryptionSpecResponse,InitializeEncryptionSpecMetadata> initializeEncryptionSpecOperationCallable()

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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   InitializeEncryptionSpecRequest request =
       InitializeEncryptionSpecRequest.newBuilder()
           .setEncryptionSpec(EncryptionSpec.newBuilder().build())
           .build();
   OperationFuture<InitializeEncryptionSpecResponse, InitializeEncryptionSpecMetadata> future =
       encryptionSpecServiceClient
           .initializeEncryptionSpecOperationCallable()
           .futureCall(request);
   // Do something.
   InitializeEncryptionSpecResponse response = future.get();
 }

Returns
Type	Description
`OperationCallable<InitializeEncryptionSpecRequest,InitializeEncryptionSpecResponse,InitializeEncryptionSpecMetadata>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listLocations(ListLocationsRequest request)

public final EncryptionSpecServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


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

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

Returns
Type	Description
`EncryptionSpecServiceClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         encryptionSpecServiceClient.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;
     }
   }
 }

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

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,EncryptionSpecServiceClient.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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
     EncryptionSpecServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       encryptionSpecServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

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

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()