com.google.cloud.dialogflow.v2beta1.EncryptionSpecServiceClient Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dialogflow.v2beta1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.v2beta1.stub.EncryptionSpecServiceStub;
import com.google.cloud.dialogflow.v2beta1.stub.EncryptionSpecServiceStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@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);
* }
* }
*
* 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:
*
*
{@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
* EncryptionSpecServiceSettings encryptionSpecServiceSettings =
* EncryptionSpecServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* EncryptionSpecServiceClient encryptionSpecServiceClient =
* EncryptionSpecServiceClient.create(encryptionSpecServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* EncryptionSpecServiceSettings encryptionSpecServiceSettings =
* EncryptionSpecServiceSettings.newHttpJsonBuilder().build();
* EncryptionSpecServiceClient encryptionSpecServiceClient =
* EncryptionSpecServiceClient.create(encryptionSpecServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class EncryptionSpecServiceClient implements BackgroundResource {
private final EncryptionSpecServiceSettings settings;
private final EncryptionSpecServiceStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of EncryptionSpecServiceClient with default settings. */
public static final EncryptionSpecServiceClient create() throws IOException {
return create(EncryptionSpecServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final EncryptionSpecServiceClient create(EncryptionSpecServiceSettings settings)
throws IOException {
return new EncryptionSpecServiceClient(settings);
}
/**
* Constructs an instance of EncryptionSpecServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(EncryptionSpecServiceSettings).
*/
public static final EncryptionSpecServiceClient create(EncryptionSpecServiceStub stub) {
return new EncryptionSpecServiceClient(stub);
}
/**
* 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.
*/
protected EncryptionSpecServiceClient(EncryptionSpecServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((EncryptionSpecServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected EncryptionSpecServiceClient(EncryptionSpecServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final EncryptionSpecServiceSettings getSettings() {
return settings;
}
public EncryptionSpecServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets location-level encryption key specification.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the encryption spec resource to get.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EncryptionSpec getEncryptionSpec(EncryptionSpecName name) {
GetEncryptionSpecRequest request =
GetEncryptionSpecRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getEncryptionSpec(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets location-level encryption key specification.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the encryption spec resource to get.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EncryptionSpec getEncryptionSpec(String name) {
GetEncryptionSpecRequest request = GetEncryptionSpecRequest.newBuilder().setName(name).build();
return getEncryptionSpec(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets location-level encryption key specification.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final EncryptionSpec getEncryptionSpec(GetEncryptionSpecRequest request) {
return getEncryptionSpecCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets location-level encryption key specification.
*
* Sample code:
*
*
{@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 future =
* encryptionSpecServiceClient.getEncryptionSpecCallable().futureCall(request);
* // Do something.
* EncryptionSpec response = future.get();
* }
* }
*/
public final UnaryCallable getEncryptionSpecCallable() {
return stub.getEncryptionSpecCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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();
* }
* }
*
* @param 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.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
initializeEncryptionSpecAsync(EncryptionSpec encryptionSpec) {
InitializeEncryptionSpecRequest request =
InitializeEncryptionSpecRequest.newBuilder().setEncryptionSpec(encryptionSpec).build();
return initializeEncryptionSpecAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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();
* }
* }
*
* @param 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
*/
public final OperationFuture
initializeEncryptionSpecAsync(InitializeEncryptionSpecRequest request) {
return initializeEncryptionSpecOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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 future =
* encryptionSpecServiceClient
* .initializeEncryptionSpecOperationCallable()
* .futureCall(request);
* // Do something.
* InitializeEncryptionSpecResponse response = future.get();
* }
* }
*/
public final OperationCallable<
InitializeEncryptionSpecRequest,
InitializeEncryptionSpecResponse,
InitializeEncryptionSpecMetadata>
initializeEncryptionSpecOperationCallable() {
return stub.initializeEncryptionSpecOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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 future =
* encryptionSpecServiceClient.initializeEncryptionSpecCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
initializeEncryptionSpecCallable() {
return stub.initializeEncryptionSpecCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 future =
* encryptionSpecServiceClient.listLocationsPagedCallable().futureCall(request);
* // Do something.
* for (Location element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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;
* }
* }
* }
* }
*/
public final UnaryCallable listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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 future =
* encryptionSpecServiceClient.getLocationCallable().futureCall(request);
* // Do something.
* Location response = future.get();
* }
* }
*/
public final UnaryCallable getLocationCallable() {
return stub.getLocationCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListLocationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListLocationsPagedResponse(ListLocationsPage page) {
super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListLocationsPage
extends AbstractPage<
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {
private ListLocationsPage(
PageContext context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}