Package com.google.ads.googleads.v14.services

Class CustomerUserAccessInvitationServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class CustomerUserAccessInvitationServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: This service manages the access invitation extended to users for a given customer.

    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 (CustomerUserAccessInvitationServiceClient customerUserAccessInvitationServiceClient =
     CustomerUserAccessInvitationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   CustomerUserAccessInvitationOperation operation =
       CustomerUserAccessInvitationOperation.newBuilder().build();
   MutateCustomerUserAccessInvitationResponse response =
       customerUserAccessInvitationServiceClient.mutateCustomerUserAccessInvitation(
           customerId, operation);
 }

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

    MutateCustomerUserAccessInvitation

    Creates or removes an access invitation.

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

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

    • mutateCustomerUserAccessInvitation(MutateCustomerUserAccessInvitationRequest request)

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

    • mutateCustomerUserAccessInvitation(String customerId, CustomerUserAccessInvitationOperation operation)

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

    • mutateCustomerUserAccessInvitationCallable()

    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 CustomerUserAccessInvitationServiceSettings 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
 CustomerUserAccessInvitationServiceSettings customerUserAccessInvitationServiceSettings =
     CustomerUserAccessInvitationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomerUserAccessInvitationServiceClient customerUserAccessInvitationServiceClient =
     CustomerUserAccessInvitationServiceClient.create(
         customerUserAccessInvitationServiceSettings);

    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
 CustomerUserAccessInvitationServiceSettings customerUserAccessInvitationServiceSettings =
     CustomerUserAccessInvitationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomerUserAccessInvitationServiceClient customerUserAccessInvitationServiceClient =
     CustomerUserAccessInvitationServiceClient.create(
         customerUserAccessInvitationServiceSettings);

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

    • Constructor Detail

      • CustomerUserAccessInvitationServiceClient

        protected CustomerUserAccessInvitationServiceClient​(CustomerUserAccessInvitationServiceSettings settings)
                                             throws java.io.IOException
        Constructs an instance of CustomerUserAccessInvitationServiceClient, 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:
        java.io.IOException

    • Method Detail

      • create

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

      • mutateCustomerUserAccessInvitation

        public final MutateCustomerUserAccessInvitationResponse mutateCustomerUserAccessInvitation​(java.lang.String customerId,
                                                                                           CustomerUserAccessInvitationOperation operation)
        Creates or removes an access invitation.

        List of thrown errors: [AccessInvitationError]() [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 (CustomerUserAccessInvitationServiceClient customerUserAccessInvitationServiceClient =
     CustomerUserAccessInvitationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   CustomerUserAccessInvitationOperation operation =
       CustomerUserAccessInvitationOperation.newBuilder().build();
   MutateCustomerUserAccessInvitationResponse response =
       customerUserAccessInvitationServiceClient.mutateCustomerUserAccessInvitation(
           customerId, operation);
 }
        Parameters:
        customerId - Required. The ID of the customer whose access invitation is being modified.
        operation - Required. The operation to perform on the access invitation
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateCustomerUserAccessInvitation

        public final MutateCustomerUserAccessInvitationResponse mutateCustomerUserAccessInvitation​(MutateCustomerUserAccessInvitationRequest request)
        Creates or removes an access invitation.

        List of thrown errors: [AccessInvitationError]() [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 (CustomerUserAccessInvitationServiceClient customerUserAccessInvitationServiceClient =
     CustomerUserAccessInvitationServiceClient.create()) {
   MutateCustomerUserAccessInvitationRequest request =
       MutateCustomerUserAccessInvitationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(CustomerUserAccessInvitationOperation.newBuilder().build())
           .build();
   MutateCustomerUserAccessInvitationResponse response =
       customerUserAccessInvitationServiceClient.mutateCustomerUserAccessInvitation(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

      • mutateCustomerUserAccessInvitationCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateCustomerUserAccessInvitationRequest,​MutateCustomerUserAccessInvitationResponse> mutateCustomerUserAccessInvitationCallable()
        Creates or removes an access invitation.

        List of thrown errors: [AccessInvitationError]() [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 (CustomerUserAccessInvitationServiceClient customerUserAccessInvitationServiceClient =
     CustomerUserAccessInvitationServiceClient.create()) {
   MutateCustomerUserAccessInvitationRequest request =
       MutateCustomerUserAccessInvitationRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(CustomerUserAccessInvitationOperation.newBuilder().build())
           .build();
   ApiFuture<MutateCustomerUserAccessInvitationResponse> future =
       customerUserAccessInvitationServiceClient
           .mutateCustomerUserAccessInvitationCallable()
           .futureCall(request);
   // Do something.
   MutateCustomerUserAccessInvitationResponse response = future.get();
 }

      • close

        public final void close()
        Specified by:
        close in interface java.lang.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,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException
        Specified by:
        awaitTermination in interface com.google.api.gax.core.BackgroundResource
        Throws:
        java.lang.InterruptedException