Package com.google.ads.googleads.v10.services

Class CustomerUserAccessServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class CustomerUserAccessServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: This service manages the permissions of a user on 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: 

    
 try (CustomerUserAccessServiceClient customerUserAccessServiceClient =
     CustomerUserAccessServiceClient.create()) {
   String customerId = "customerId-1581184615";
   CustomerUserAccessOperation operation = CustomerUserAccessOperation.newBuilder().build();
   MutateCustomerUserAccessResponse response =
       customerUserAccessServiceClient.mutateCustomerUserAccess(customerId, operation);
 }

    Note: close() needs to be called on the CustomerUserAccessServiceClient 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 CustomerUserAccessServiceSettings to create(). For example:

    To customize credentials: 

    
 CustomerUserAccessServiceSettings customerUserAccessServiceSettings =
     CustomerUserAccessServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomerUserAccessServiceClient customerUserAccessServiceClient =
     CustomerUserAccessServiceClient.create(customerUserAccessServiceSettings);

    To customize the endpoint: 

    
 CustomerUserAccessServiceSettings customerUserAccessServiceSettings =
     CustomerUserAccessServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomerUserAccessServiceClient customerUserAccessServiceClient =
     CustomerUserAccessServiceClient.create(customerUserAccessServiceSettings);

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

    • Constructor Detail

      • CustomerUserAccessServiceClient

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

      • CustomerUserAccessServiceClient

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected CustomerUserAccessServiceClient​(CustomerUserAccessServiceStub stub)

    • Method Detail

      • create

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

      • create

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

      • create

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final CustomerUserAccessServiceClient create​(CustomerUserAccessServiceStub stub)
        Constructs an instance of CustomerUserAccessServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CustomerUserAccessServiceSettings).

      • getStub

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public CustomerUserAccessServiceStub getStub()

      • mutateCustomerUserAccess

        public final MutateCustomerUserAccessResponse mutateCustomerUserAccess​(java.lang.String customerId,
                                                                       CustomerUserAccessOperation operation)
        Updates, removes permission of a user on a given customer. Operation statuses are returned.

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

        Sample code: 

        
 try (CustomerUserAccessServiceClient customerUserAccessServiceClient =
     CustomerUserAccessServiceClient.create()) {
   String customerId = "customerId-1581184615";
   CustomerUserAccessOperation operation = CustomerUserAccessOperation.newBuilder().build();
   MutateCustomerUserAccessResponse response =
       customerUserAccessServiceClient.mutateCustomerUserAccess(customerId, operation);
 }
        Parameters:
        customerId - Required. The ID of the customer being modified.
        operation - Required. The operation to perform on the customer
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateCustomerUserAccess

        public final MutateCustomerUserAccessResponse mutateCustomerUserAccess​(MutateCustomerUserAccessRequest request)
        Updates, removes permission of a user on a given customer. Operation statuses are returned.

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

        Sample code: 

        
 try (CustomerUserAccessServiceClient customerUserAccessServiceClient =
     CustomerUserAccessServiceClient.create()) {
   MutateCustomerUserAccessRequest request =
       MutateCustomerUserAccessRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(CustomerUserAccessOperation.newBuilder().build())
           .build();
   MutateCustomerUserAccessResponse response =
       customerUserAccessServiceClient.mutateCustomerUserAccess(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

      • mutateCustomerUserAccessCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateCustomerUserAccessRequest,​MutateCustomerUserAccessResponse> mutateCustomerUserAccessCallable()
        Updates, removes permission of a user on a given customer. Operation statuses are returned.

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

        Sample code: 

        
 try (CustomerUserAccessServiceClient customerUserAccessServiceClient =
     CustomerUserAccessServiceClient.create()) {
   MutateCustomerUserAccessRequest request =
       MutateCustomerUserAccessRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(CustomerUserAccessOperation.newBuilder().build())
           .build();
   ApiFuture<MutateCustomerUserAccessResponse> future =
       customerUserAccessServiceClient.mutateCustomerUserAccessCallable().futureCall(request);
   // Do something.
   MutateCustomerUserAccessResponse 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