Package com.google.maps.addressvalidation.v1

Class AddressValidationClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class AddressValidationClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: The service for validating addresses.

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

    The surface of this class includes several types of Java methods for each of the API's methods:

    1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
    2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
    3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

    See the individual methods for example code.

    Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

    This class can be customized by passing in a custom instance of 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.

    • Constructor Detail

      • AddressValidationClient

        protected AddressValidationClient​(AddressValidationSettings settings)
                           throws IOException
        Constructs an instance of AddressValidationClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
        Throws:
        IOException

    • Method Detail

      • create

        public static final AddressValidationClient create​(AddressValidationStub stub)
        Constructs an instance of AddressValidationClient, using the given stub for making calls. This is for advanced usage - prefer using create(AddressValidationSettings).

      • validateAddress

        public final ValidateAddressResponse validateAddress​(ValidateAddressRequest request)
        Validates an address.

        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)
           .build();
   ValidateAddressResponse response = addressValidationClient.validateAddress(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • validateAddressCallable

        public final com.google.api.gax.rpc.UnaryCallable<ValidateAddressRequest,​ValidateAddressResponse> validateAddressCallable()
        Validates an address.

        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)
           .build();
   ApiFuture<ValidateAddressResponse> future =
       addressValidationClient.validateAddressCallable().futureCall(request);
   // Do something.
   ValidateAddressResponse response = future.get();
 }

      • provideValidationFeedback

        public final ProvideValidationFeedbackResponse provideValidationFeedback​(ProvideValidationFeedbackRequest request)
        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.

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • provideValidationFeedbackCallable

        public final com.google.api.gax.rpc.UnaryCallable<ProvideValidationFeedbackRequest,​ProvideValidationFeedbackResponse> provideValidationFeedbackCallable()
        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.

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

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource