Package com.google.ads.googleads.v24.services

Class MultiPartyAuthReviewServiceClient

java.lang.Object
com.google.ads.googleads.v24.services.MultiPartyAuthReviewServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class MultiPartyAuthReviewServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage Multi-Party Authorization requests.

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 (MultiPartyAuthReviewServiceClient multiPartyAuthReviewServiceClient =
     MultiPartyAuthReviewServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<ResolveMultiPartyAuthReviewOperation> operations = new ArrayList<>();
   ResolveMultiPartyAuthReviewResponse response =
       multiPartyAuthReviewServiceClient.resolveMultiPartyAuthReview(customerId, operations);
 }

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

ResolveMultiPartyAuthReview

Resolves the status of a Multi-Party Authorization review.

List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CustomerUserAccessError]() [FieldError]() [HeaderError]() [InternalError]() [MultiPartyAuthReviewError]() [MutateError]() [QuotaError]() [RangeError]() [RequestError]()

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

  • resolveMultiPartyAuthReview(ResolveMultiPartyAuthReviewRequest request)

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

  • resolveMultiPartyAuthReview(String customerId, List<ResolveMultiPartyAuthReviewOperation> operations)

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

  • resolveMultiPartyAuthReviewCallable()

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 MultiPartyAuthReviewServiceSettings 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
 MultiPartyAuthReviewServiceSettings multiPartyAuthReviewServiceSettings =
     MultiPartyAuthReviewServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MultiPartyAuthReviewServiceClient multiPartyAuthReviewServiceClient =
     MultiPartyAuthReviewServiceClient.create(multiPartyAuthReviewServiceSettings);

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
 MultiPartyAuthReviewServiceSettings multiPartyAuthReviewServiceSettings =
     MultiPartyAuthReviewServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MultiPartyAuthReviewServiceClient multiPartyAuthReviewServiceClient =
     MultiPartyAuthReviewServiceClient.create(multiPartyAuthReviewServiceSettings);

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

  • Constructor Details

    • MultiPartyAuthReviewServiceClient

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

    • MultiPartyAuthReviewServiceClient

      protected MultiPartyAuthReviewServiceClient(MultiPartyAuthReviewServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final MultiPartyAuthReviewServiceClient create(MultiPartyAuthReviewServiceSettings settings) throws IOException
      Constructs an instance of MultiPartyAuthReviewServiceClient, 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 MultiPartyAuthReviewServiceClient create(MultiPartyAuthReviewServiceStub stub)
      Constructs an instance of MultiPartyAuthReviewServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(MultiPartyAuthReviewServiceSettings).

    • getSettings

      public final MultiPartyAuthReviewServiceSettings getSettings()

    • getStub

      public MultiPartyAuthReviewServiceStub getStub()

    • resolveMultiPartyAuthReview

      public final ResolveMultiPartyAuthReviewResponse resolveMultiPartyAuthReview(String customerId, List<ResolveMultiPartyAuthReviewOperation> operations)
      Resolves the status of a Multi-Party Authorization review.

      List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CustomerUserAccessError]() [FieldError]() [HeaderError]() [InternalError]() [MultiPartyAuthReviewError]() [MutateError]() [QuotaError]() [RangeError]() [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 (MultiPartyAuthReviewServiceClient multiPartyAuthReviewServiceClient =
     MultiPartyAuthReviewServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<ResolveMultiPartyAuthReviewOperation> operations = new ArrayList<>();
   ResolveMultiPartyAuthReviewResponse response =
       multiPartyAuthReviewServiceClient.resolveMultiPartyAuthReview(customerId, operations);
 }
      Parameters:
      customerId - Required. The ID of the customer.
      operations - Required. The operations to perform. Currently only one operation is supported.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • resolveMultiPartyAuthReview

      public final ResolveMultiPartyAuthReviewResponse resolveMultiPartyAuthReview(ResolveMultiPartyAuthReviewRequest request)
      Resolves the status of a Multi-Party Authorization review.

      List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CustomerUserAccessError]() [FieldError]() [HeaderError]() [InternalError]() [MultiPartyAuthReviewError]() [MutateError]() [QuotaError]() [RangeError]() [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 (MultiPartyAuthReviewServiceClient multiPartyAuthReviewServiceClient =
     MultiPartyAuthReviewServiceClient.create()) {
   ResolveMultiPartyAuthReviewRequest request =
       ResolveMultiPartyAuthReviewRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<ResolveMultiPartyAuthReviewOperation>())
           .build();
   ResolveMultiPartyAuthReviewResponse response =
       multiPartyAuthReviewServiceClient.resolveMultiPartyAuthReview(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

    • resolveMultiPartyAuthReviewCallable

      public final com.google.api.gax.rpc.UnaryCallable<ResolveMultiPartyAuthReviewRequest,ResolveMultiPartyAuthReviewResponse> resolveMultiPartyAuthReviewCallable()
      Resolves the status of a Multi-Party Authorization review.

      List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CustomerUserAccessError]() [FieldError]() [HeaderError]() [InternalError]() [MultiPartyAuthReviewError]() [MutateError]() [QuotaError]() [RangeError]() [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 (MultiPartyAuthReviewServiceClient multiPartyAuthReviewServiceClient =
     MultiPartyAuthReviewServiceClient.create()) {
   ResolveMultiPartyAuthReviewRequest request =
       ResolveMultiPartyAuthReviewRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<ResolveMultiPartyAuthReviewOperation>())
           .build();
   ApiFuture<ResolveMultiPartyAuthReviewResponse> future =
       multiPartyAuthReviewServiceClient
           .resolveMultiPartyAuthReviewCallable()
           .futureCall(request);
   // Do something.
   ResolveMultiPartyAuthReviewResponse 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