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

Class LabelServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class LabelServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to manage labels.

    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 (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<LabelOperation> operations = new ArrayList<>();
   MutateLabelsResponse response = labelServiceClient.mutateLabels(customerId, operations);
 }

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

    To customize credentials: 

    
 LabelServiceSettings labelServiceSettings =
     LabelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LabelServiceClient labelServiceClient = LabelServiceClient.create(labelServiceSettings);

    To customize the endpoint: 

    
 LabelServiceSettings labelServiceSettings =
     LabelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LabelServiceClient labelServiceClient = LabelServiceClient.create(labelServiceSettings);

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

    • Constructor Detail

      • LabelServiceClient

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

      • LabelServiceClient

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

    • Method Detail

      • create

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

      • create

        public static final LabelServiceClient create​(LabelServiceSettings settings)
                                       throws java.io.IOException
        Constructs an instance of LabelServiceClient, 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 LabelServiceClient create​(LabelServiceStub stub)
        Constructs an instance of LabelServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(LabelServiceSettings).

      • getStub

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

      • mutateLabels

        public final MutateLabelsResponse mutateLabels​(java.lang.String customerId,
                                               java.util.List<LabelOperation> operations)
        Creates, updates, or removes labels. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

        Sample code: 

        
 try (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<LabelOperation> operations = new ArrayList<>();
   MutateLabelsResponse response = labelServiceClient.mutateLabels(customerId, operations);
 }
        Parameters:
        customerId - Required. ID of the customer whose labels are being modified.
        operations - Required. The list of operations to perform on labels.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateLabels

        public final MutateLabelsResponse mutateLabels​(MutateLabelsRequest request)
        Creates, updates, or removes labels. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

        Sample code: 

        
 try (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   MutateLabelsRequest request =
       MutateLabelsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<LabelOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateLabelsResponse response = labelServiceClient.mutateLabels(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

      • mutateLabelsCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateLabelsRequest,​MutateLabelsResponse> mutateLabelsCallable()
        Creates, updates, or removes labels. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

        Sample code: 

        
 try (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   MutateLabelsRequest request =
       MutateLabelsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<LabelOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateLabelsResponse> future =
       labelServiceClient.mutateLabelsCallable().futureCall(request);
   // Do something.
   MutateLabelsResponse 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