@Generated(value="by gapic-generator-java") public class AddressValidationClient extends Object implements com.google.api.gax.core.BackgroundResource
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 (AddressValidationClient addressValidationClient = AddressValidationClient.create()) {
ValidateAddressRequest request =
ValidateAddressRequest.newBuilder()
.setAddress(PostalAddress.newBuilder().build())
.setPreviousResponseId("previousResponseId468754323")
.setEnableUspsCass(true)
.setSessionToken("sessionToken-696552189")
.build();
ValidateAddressResponse response = addressValidationClient.validateAddress(request);
}
Note: close() needs to be called on the AddressValidationClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
ValidateAddress |
Validates an address. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ProvideValidationFeedback |
Feedback about the outcome of the sequence of validation attempts. This should be the last call made after a sequence of validation calls for the same address, and should be called once the transaction is concluded. This should only be sent once for the sequence of `ValidateAddress` requests needed to validate an address fully. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 AddressValidationSettings 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
AddressValidationSettings addressValidationSettings =
AddressValidationSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AddressValidationClient addressValidationClient =
AddressValidationClient.create(addressValidationSettings);
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
AddressValidationSettings addressValidationSettings =
AddressValidationSettings.newBuilder().setEndpoint(myEndpoint).build();
AddressValidationClient addressValidationClient =
AddressValidationClient.create(addressValidationSettings);
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
AddressValidationSettings addressValidationSettings =
AddressValidationSettings.newHttpJsonBuilder().build();
AddressValidationClient addressValidationClient =
AddressValidationClient.create(addressValidationSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
| Modifier | Constructor and Description |
|---|---|
protected |
AddressValidationClient(AddressValidationSettings settings)
Constructs an instance of AddressValidationClient, using the given settings.
|
protected |
AddressValidationClient(AddressValidationStub stub) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static AddressValidationClient |
create()
Constructs an instance of AddressValidationClient with default settings.
|
static AddressValidationClient |
create(AddressValidationSettings settings)
Constructs an instance of AddressValidationClient, using the given settings.
|
static AddressValidationClient |
create(AddressValidationStub stub)
Constructs an instance of AddressValidationClient, using the given stub for making calls.
|
AddressValidationSettings |
getSettings() |
AddressValidationStub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
ProvideValidationFeedbackResponse |
provideValidationFeedback(ProvideValidationFeedbackRequest request)
Feedback about the outcome of the sequence of validation attempts.
|
com.google.api.gax.rpc.UnaryCallable<ProvideValidationFeedbackRequest,ProvideValidationFeedbackResponse> |
provideValidationFeedbackCallable()
Feedback about the outcome of the sequence of validation attempts.
|
void |
shutdown() |
void |
shutdownNow() |
ValidateAddressResponse |
validateAddress(ValidateAddressRequest request)
Validates an address.
|
com.google.api.gax.rpc.UnaryCallable<ValidateAddressRequest,ValidateAddressResponse> |
validateAddressCallable()
Validates an address.
|
protected AddressValidationClient(AddressValidationSettings settings) throws IOException
IOExceptionprotected AddressValidationClient(AddressValidationStub stub)
public static final AddressValidationClient create() throws IOException
IOExceptionpublic static final AddressValidationClient create(AddressValidationSettings settings) throws IOException
IOExceptionpublic static final AddressValidationClient create(AddressValidationStub stub)
public final AddressValidationSettings getSettings()
public AddressValidationStub getStub()
public final ValidateAddressResponse validateAddress(ValidateAddressRequest 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 (AddressValidationClient addressValidationClient = AddressValidationClient.create()) {
ValidateAddressRequest request =
ValidateAddressRequest.newBuilder()
.setAddress(PostalAddress.newBuilder().build())
.setPreviousResponseId("previousResponseId468754323")
.setEnableUspsCass(true)
.setSessionToken("sessionToken-696552189")
.build();
ValidateAddressResponse response = addressValidationClient.validateAddress(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ValidateAddressRequest,ValidateAddressResponse> validateAddressCallable()
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 (AddressValidationClient addressValidationClient = AddressValidationClient.create()) {
ValidateAddressRequest request =
ValidateAddressRequest.newBuilder()
.setAddress(PostalAddress.newBuilder().build())
.setPreviousResponseId("previousResponseId468754323")
.setEnableUspsCass(true)
.setSessionToken("sessionToken-696552189")
.build();
ApiFuture<ValidateAddressResponse> future =
addressValidationClient.validateAddressCallable().futureCall(request);
// Do something.
ValidateAddressResponse response = future.get();
}
public final ProvideValidationFeedbackResponse provideValidationFeedback(ProvideValidationFeedbackRequest 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 (AddressValidationClient addressValidationClient = AddressValidationClient.create()) {
ProvideValidationFeedbackRequest request =
ProvideValidationFeedbackRequest.newBuilder()
.setResponseId("responseId-633138884")
.build();
ProvideValidationFeedbackResponse response =
addressValidationClient.provideValidationFeedback(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ProvideValidationFeedbackRequest,ProvideValidationFeedbackResponse> provideValidationFeedbackCallable()
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 (AddressValidationClient addressValidationClient = AddressValidationClient.create()) {
ProvideValidationFeedbackRequest request =
ProvideValidationFeedbackRequest.newBuilder()
.setResponseId("responseId-633138884")
.build();
ApiFuture<ProvideValidationFeedbackResponse> future =
addressValidationClient.provideValidationFeedbackCallable().futureCall(request);
// Do something.
ProvideValidationFeedbackResponse response = future.get();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2025 Google LLC. All rights reserved.