Class GlobalAddressesClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable

    @Generated("by gapic-generator-java")
    public class GlobalAddressesClient
    extends Object
    implements com.google.api.gax.core.BackgroundResource
    Service Description: The GlobalAddresses API.

    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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
       String project = "project-309310695";
       String address = "address-1147692044";
       Address response = globalAddressesClient.get(project, address);
     }
     

    Note: close() needs to be called on the GlobalAddressesClient 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 GlobalAddressesSettings 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
     GlobalAddressesSettings globalAddressesSettings =
         GlobalAddressesSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     GlobalAddressesClient globalAddressesClient =
         GlobalAddressesClient.create(globalAddressesSettings);
     

    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
     GlobalAddressesSettings globalAddressesSettings =
         GlobalAddressesSettings.newBuilder().setEndpoint(myEndpoint).build();
     GlobalAddressesClient globalAddressesClient =
         GlobalAddressesClient.create(globalAddressesSettings);
     

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

    • Constructor Detail

      • GlobalAddressesClient

        protected GlobalAddressesClient​(GlobalAddressesSettings settings)
                                 throws IOException
        Constructs an instance of GlobalAddressesClient, 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
    • Method Detail

      • create

        public static final GlobalAddressesClient create​(GlobalAddressesStub stub)
        Constructs an instance of GlobalAddressesClient, using the given stub for making calls. This is for advanced usage - prefer using create(GlobalAddressesSettings).
      • deleteAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> deleteAsync​(String project,
                                                                                                           String address)
        Deletes the specified address resource.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           String project = "project-309310695";
           String address = "address-1147692044";
           Operation response = globalAddressesClient.deleteAsync(project, address).get();
         }
         
        Parameters:
        project - Project ID for this request.
        address - Name of the address resource to delete.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> deleteAsync​(DeleteGlobalAddressRequest request)
        Deletes the specified address resource.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           DeleteGlobalAddressRequest request =
               DeleteGlobalAddressRequest.newBuilder()
                   .setAddress("address-1147692044")
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           Operation response = globalAddressesClient.deleteAsync(request).get();
         }
         
        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
      • deleteOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteGlobalAddressRequest,​Operation,​Operation> deleteOperationCallable()
        Deletes the specified address resource.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           DeleteGlobalAddressRequest request =
               DeleteGlobalAddressRequest.newBuilder()
                   .setAddress("address-1147692044")
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           OperationFuture<Operation, Operation> future =
               globalAddressesClient.deleteOperationCallable().futureCall(request);
           // Do something.
           Operation response = future.get();
         }
         
      • deleteCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteGlobalAddressRequest,​Operation> deleteCallable()
        Deletes the specified address resource.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           DeleteGlobalAddressRequest request =
               DeleteGlobalAddressRequest.newBuilder()
                   .setAddress("address-1147692044")
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           ApiFuture<Operation> future = globalAddressesClient.deleteCallable().futureCall(request);
           // Do something.
           Operation response = future.get();
         }
         
      • get

        public final Address get​(String project,
                                 String address)
        Returns the specified address resource.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           String project = "project-309310695";
           String address = "address-1147692044";
           Address response = globalAddressesClient.get(project, address);
         }
         
        Parameters:
        project - Project ID for this request.
        address - Name of the address resource to return.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • get

        public final Address get​(GetGlobalAddressRequest request)
        Returns the specified address resource.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           GetGlobalAddressRequest request =
               GetGlobalAddressRequest.newBuilder()
                   .setAddress("address-1147692044")
                   .setProject("project-309310695")
                   .build();
           Address response = globalAddressesClient.get(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
      • getCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetGlobalAddressRequest,​Address> getCallable()
        Returns the specified address resource.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           GetGlobalAddressRequest request =
               GetGlobalAddressRequest.newBuilder()
                   .setAddress("address-1147692044")
                   .setProject("project-309310695")
                   .build();
           ApiFuture<Address> future = globalAddressesClient.getCallable().futureCall(request);
           // Do something.
           Address response = future.get();
         }
         
      • insertAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> insertAsync​(String project,
                                                                                                           Address addressResource)
        Creates an address resource in the specified project by using the data included in the request.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           String project = "project-309310695";
           Address addressResource = Address.newBuilder().build();
           Operation response = globalAddressesClient.insertAsync(project, addressResource).get();
         }
         
        Parameters:
        project - Project ID for this request.
        addressResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • insertAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> insertAsync​(InsertGlobalAddressRequest request)
        Creates an address resource in the specified project by using the data included in the request.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           InsertGlobalAddressRequest request =
               InsertGlobalAddressRequest.newBuilder()
                   .setAddressResource(Address.newBuilder().build())
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           Operation response = globalAddressesClient.insertAsync(request).get();
         }
         
        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
      • insertOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<InsertGlobalAddressRequest,​Operation,​Operation> insertOperationCallable()
        Creates an address resource in the specified project by using the data included in the request.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           InsertGlobalAddressRequest request =
               InsertGlobalAddressRequest.newBuilder()
                   .setAddressResource(Address.newBuilder().build())
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           OperationFuture<Operation, Operation> future =
               globalAddressesClient.insertOperationCallable().futureCall(request);
           // Do something.
           Operation response = future.get();
         }
         
      • insertCallable

        public final com.google.api.gax.rpc.UnaryCallable<InsertGlobalAddressRequest,​Operation> insertCallable()
        Creates an address resource in the specified project by using the data included in the request.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           InsertGlobalAddressRequest request =
               InsertGlobalAddressRequest.newBuilder()
                   .setAddressResource(Address.newBuilder().build())
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           ApiFuture<Operation> future = globalAddressesClient.insertCallable().futureCall(request);
           // Do something.
           Operation response = future.get();
         }
         
      • list

        public final GlobalAddressesClient.ListPagedResponse list​(String project)
        Retrieves a list of global addresses.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           String project = "project-309310695";
           for (Address element : globalAddressesClient.list(project).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        project - Project ID for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • list

        public final GlobalAddressesClient.ListPagedResponse list​(ListGlobalAddressesRequest request)
        Retrieves a list of global addresses.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           ListGlobalAddressesRequest request =
               ListGlobalAddressesRequest.newBuilder()
                   .setFilter("filter-1274492040")
                   .setMaxResults(1128457243)
                   .setOrderBy("orderBy-1207110587")
                   .setPageToken("pageToken873572522")
                   .setProject("project-309310695")
                   .setReturnPartialSuccess(true)
                   .build();
           for (Address element : globalAddressesClient.list(request).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        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
      • listPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListGlobalAddressesRequest,​GlobalAddressesClient.ListPagedResponse> listPagedCallable()
        Retrieves a list of global addresses.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           ListGlobalAddressesRequest request =
               ListGlobalAddressesRequest.newBuilder()
                   .setFilter("filter-1274492040")
                   .setMaxResults(1128457243)
                   .setOrderBy("orderBy-1207110587")
                   .setPageToken("pageToken873572522")
                   .setProject("project-309310695")
                   .setReturnPartialSuccess(true)
                   .build();
           ApiFuture<Address> future = globalAddressesClient.listPagedCallable().futureCall(request);
           // Do something.
           for (Address element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListGlobalAddressesRequest,​AddressList> listCallable()
        Retrieves a list of global addresses.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           ListGlobalAddressesRequest request =
               ListGlobalAddressesRequest.newBuilder()
                   .setFilter("filter-1274492040")
                   .setMaxResults(1128457243)
                   .setOrderBy("orderBy-1207110587")
                   .setPageToken("pageToken873572522")
                   .setProject("project-309310695")
                   .setReturnPartialSuccess(true)
                   .build();
           while (true) {
             AddressList response = globalAddressesClient.listCallable().call(request);
             for (Address element : response.getItemsList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • moveAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> moveAsync​(String project,
                                                                                                         String address,
                                                                                                         GlobalAddressesMoveRequest globalAddressesMoveRequestResource)
        Moves the specified address resource from one project to another project.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           String project = "project-309310695";
           String address = "address-1147692044";
           GlobalAddressesMoveRequest globalAddressesMoveRequestResource =
               GlobalAddressesMoveRequest.newBuilder().build();
           Operation response =
               globalAddressesClient
                   .moveAsync(project, address, globalAddressesMoveRequestResource)
                   .get();
         }
         
        Parameters:
        project - Source project ID which the Address is moved from.
        address - Name of the address resource to move.
        globalAddressesMoveRequestResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • moveAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> moveAsync​(MoveGlobalAddressRequest request)
        Moves the specified address resource from one project to another project.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           MoveGlobalAddressRequest request =
               MoveGlobalAddressRequest.newBuilder()
                   .setAddress("address-1147692044")
                   .setGlobalAddressesMoveRequestResource(
                       GlobalAddressesMoveRequest.newBuilder().build())
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           Operation response = globalAddressesClient.moveAsync(request).get();
         }
         
        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
      • moveOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<MoveGlobalAddressRequest,​Operation,​Operation> moveOperationCallable()
        Moves the specified address resource from one project to another project.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           MoveGlobalAddressRequest request =
               MoveGlobalAddressRequest.newBuilder()
                   .setAddress("address-1147692044")
                   .setGlobalAddressesMoveRequestResource(
                       GlobalAddressesMoveRequest.newBuilder().build())
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           OperationFuture<Operation, Operation> future =
               globalAddressesClient.moveOperationCallable().futureCall(request);
           // Do something.
           Operation response = future.get();
         }
         
      • moveCallable

        public final com.google.api.gax.rpc.UnaryCallable<MoveGlobalAddressRequest,​Operation> moveCallable()
        Moves the specified address resource from one project to another project.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           MoveGlobalAddressRequest request =
               MoveGlobalAddressRequest.newBuilder()
                   .setAddress("address-1147692044")
                   .setGlobalAddressesMoveRequestResource(
                       GlobalAddressesMoveRequest.newBuilder().build())
                   .setProject("project-309310695")
                   .setRequestId("requestId693933066")
                   .build();
           ApiFuture<Operation> future = globalAddressesClient.moveCallable().futureCall(request);
           // Do something.
           Operation response = future.get();
         }
         
      • setLabelsAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> setLabelsAsync​(String project,
                                                                                                              String resource,
                                                                                                              GlobalSetLabelsRequest globalSetLabelsRequestResource)
        Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           String project = "project-309310695";
           String resource = "resource-341064690";
           GlobalSetLabelsRequest globalSetLabelsRequestResource =
               GlobalSetLabelsRequest.newBuilder().build();
           Operation response =
               globalAddressesClient
                   .setLabelsAsync(project, resource, globalSetLabelsRequestResource)
                   .get();
         }
         
        Parameters:
        project - Project ID for this request.
        resource - Name or id of the resource for this request.
        globalSetLabelsRequestResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • setLabelsAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> setLabelsAsync​(SetLabelsGlobalAddressRequest request)
        Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           SetLabelsGlobalAddressRequest request =
               SetLabelsGlobalAddressRequest.newBuilder()
                   .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
                   .setProject("project-309310695")
                   .setResource("resource-341064690")
                   .build();
           Operation response = globalAddressesClient.setLabelsAsync(request).get();
         }
         
        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
      • setLabelsOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<SetLabelsGlobalAddressRequest,​Operation,​Operation> setLabelsOperationCallable()
        Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           SetLabelsGlobalAddressRequest request =
               SetLabelsGlobalAddressRequest.newBuilder()
                   .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
                   .setProject("project-309310695")
                   .setResource("resource-341064690")
                   .build();
           OperationFuture<Operation, Operation> future =
               globalAddressesClient.setLabelsOperationCallable().futureCall(request);
           // Do something.
           Operation response = future.get();
         }
         
      • setLabelsCallable

        public final com.google.api.gax.rpc.UnaryCallable<SetLabelsGlobalAddressRequest,​Operation> setLabelsCallable()
        Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

        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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
           SetLabelsGlobalAddressRequest request =
               SetLabelsGlobalAddressRequest.newBuilder()
                   .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
                   .setProject("project-309310695")
                   .setResource("resource-341064690")
                   .build();
           ApiFuture<Operation> future = globalAddressesClient.setLabelsCallable().futureCall(request);
           // Do something.
           Operation response = future.get();
         }
         
      • 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