Package com.google.ads.googleads.v18.services

Class IdentityVerificationServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.IdentityVerificationServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class IdentityVerificationServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: A service for managing Identity Verification Service.

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 (IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   IdentityVerificationProgramEnum.IdentityVerificationProgram verificationProgram =
       IdentityVerificationProgramEnum.IdentityVerificationProgram.forNumber(0);
   identityVerificationServiceClient.startIdentityVerification(customerId, verificationProgram);
 }

Note: close() needs to be called on the IdentityVerificationServiceClient 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

StartIdentityVerification

Starts Identity Verification for a given verification program type. Statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

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

  • startIdentityVerification(StartIdentityVerificationRequest request)

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

  • startIdentityVerification(String customerId, IdentityVerificationProgramEnum.IdentityVerificationProgram verificationProgram)

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

  • startIdentityVerificationCallable()

GetIdentityVerification

Returns Identity Verification information.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

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

  • getIdentityVerification(GetIdentityVerificationRequest request)

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

  • getIdentityVerification(String customerId)

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

  • getIdentityVerificationCallable()

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 IdentityVerificationServiceSettings 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
 IdentityVerificationServiceSettings identityVerificationServiceSettings =
     IdentityVerificationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create(identityVerificationServiceSettings);

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
 IdentityVerificationServiceSettings identityVerificationServiceSettings =
     IdentityVerificationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create(identityVerificationServiceSettings);

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

  • Constructor Details

    • IdentityVerificationServiceClient

      protected IdentityVerificationServiceClient(IdentityVerificationServiceSettings settings) throws IOException
      Constructs an instance of IdentityVerificationServiceClient, 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

    • IdentityVerificationServiceClient

      protected IdentityVerificationServiceClient(IdentityVerificationServiceStub stub)

  • Method Details

    • create

      public static final IdentityVerificationServiceClient create() throws IOException
      Constructs an instance of IdentityVerificationServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final IdentityVerificationServiceClient create(IdentityVerificationServiceSettings settings) throws IOException
      Constructs an instance of IdentityVerificationServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException

    • create

      public static final IdentityVerificationServiceClient create(IdentityVerificationServiceStub stub)
      Constructs an instance of IdentityVerificationServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(IdentityVerificationServiceSettings).

    • getSettings

      public final IdentityVerificationServiceSettings getSettings()

    • getStub

      public IdentityVerificationServiceStub getStub()

    • startIdentityVerification

      public final void startIdentityVerification(String customerId, IdentityVerificationProgramEnum.IdentityVerificationProgram verificationProgram)
      Starts Identity Verification for a given verification program type. Statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      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 (IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   IdentityVerificationProgramEnum.IdentityVerificationProgram verificationProgram =
       IdentityVerificationProgramEnum.IdentityVerificationProgram.forNumber(0);
   identityVerificationServiceClient.startIdentityVerification(customerId, verificationProgram);
 }
      Parameters:
      customerId - Required. The Id of the customer for whom we are creating this verification.
      verificationProgram - Required. The verification program type for which we want to start the verification.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • startIdentityVerification

      public final void startIdentityVerification(StartIdentityVerificationRequest request)
      Starts Identity Verification for a given verification program type. Statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      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 (IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create()) {
   StartIdentityVerificationRequest request =
       StartIdentityVerificationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   identityVerificationServiceClient.startIdentityVerification(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

    • startIdentityVerificationCallable

      public final com.google.api.gax.rpc.UnaryCallable<StartIdentityVerificationRequest,com.google.protobuf.Empty> startIdentityVerificationCallable()
      Starts Identity Verification for a given verification program type. Statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      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 (IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create()) {
   StartIdentityVerificationRequest request =
       StartIdentityVerificationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   ApiFuture<Empty> future =
       identityVerificationServiceClient.startIdentityVerificationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • getIdentityVerification

      public final GetIdentityVerificationResponse getIdentityVerification(String customerId)
      Returns Identity Verification information.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      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 (IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   GetIdentityVerificationResponse response =
       identityVerificationServiceClient.getIdentityVerification(customerId);
 }
      Parameters:
      customerId - Required. The ID of the customer for whom we are requesting verification information.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • getIdentityVerification

      public final GetIdentityVerificationResponse getIdentityVerification(GetIdentityVerificationRequest request)
      Returns Identity Verification information.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      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 (IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create()) {
   GetIdentityVerificationRequest request =
       GetIdentityVerificationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   GetIdentityVerificationResponse response =
       identityVerificationServiceClient.getIdentityVerification(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

    • getIdentityVerificationCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetIdentityVerificationRequest,GetIdentityVerificationResponse> getIdentityVerificationCallable()
      Returns Identity Verification information.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

      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 (IdentityVerificationServiceClient identityVerificationServiceClient =
     IdentityVerificationServiceClient.create()) {
   GetIdentityVerificationRequest request =
       GetIdentityVerificationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   ApiFuture<GetIdentityVerificationResponse> future =
       identityVerificationServiceClient.getIdentityVerificationCallable().futureCall(request);
   // Do something.
   GetIdentityVerificationResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • 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

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface com.google.api.gax.core.BackgroundResource
      Throws:
      InterruptedException