Class AddressesClient (1.41.0)

Version 1.41.0

• 1.62.0 (latest)
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

GitHub Repository

Product Reference

Service Description: The Addresses 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 (AddressesClient addressesClient = AddressesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String address = "address-1147692044";
   Address response = addressesClient.get(project, region, address);
 }
 

Note: close() needs to be called on the AddressesClient 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 AddressesSettings 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
 AddressesSettings addressesSettings =
     AddressesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AddressesClient addressesClient = AddressesClient.create(addressesSettings);
 

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
 AddressesSettings addressesSettings =
     AddressesSettings.newBuilder().setEndpoint(myEndpoint).build();
 AddressesClient addressesClient = AddressesClient.create(addressesSettings);
 

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

Inheritance

java.lang.Object > AddressesClient

Static Methods

create()

public static final AddressesClient create()

Constructs an instance of AddressesClient with default settings.

Returns
Type	Description
AddressesClient

Exceptions
Type	Description
IOException

create(AddressesSettings settings)

public static final AddressesClient create(AddressesSettings settings)

Constructs an instance of AddressesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
settings	AddressesSettings

Returns
Type	Description
AddressesClient

Exceptions
Type	Description
IOException

create(AddressesStub stub)

public static final AddressesClient create(AddressesStub stub)

Constructs an instance of AddressesClient, using the given stub for making calls. This is for advanced usage - prefer using create(AddressesSettings).

Parameter
Name	Description
stub	AddressesStub

Returns
Type	Description
AddressesClient

Constructors

AddressesClient(AddressesSettings settings)

protected AddressesClient(AddressesSettings settings)

Constructs an instance of AddressesClient, 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.

Parameter
Name	Description
settings	AddressesSettings

AddressesClient(AddressesStub stub)

protected AddressesClient(AddressesStub stub)

Parameter
Name	Description
stub	AddressesStub

Methods

aggregatedList(AggregatedListAddressesRequest request)

public final AddressesClient.AggregatedListPagedResponse aggregatedList(AggregatedListAddressesRequest request)

Retrieves an aggregated list of 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 (AddressesClient addressesClient = AddressesClient.create()) {
   AggregatedListAddressesRequest request =
       AggregatedListAddressesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, AddressesScopedList> element :
       addressesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	AggregatedListAddressesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
AddressesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final AddressesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of 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 (AddressesClient addressesClient = AddressesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, AddressesScopedList> element :
       addressesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
project	String Project ID for this request.

Returns
Type	Description
AddressesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListAddressesRequest,AddressAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of 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 (AddressesClient addressesClient = AddressesClient.create()) {
   AggregatedListAddressesRequest request =
       AggregatedListAddressesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     AddressAggregatedList response = addressesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, AddressesScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<AggregatedListAddressesRequest,AddressAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListAddressesRequest,AddressesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of 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 (AddressesClient addressesClient = AddressesClient.create()) {
   AggregatedListAddressesRequest request =
       AggregatedListAddressesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, AddressesScopedList>> future =
       addressesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, AddressesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<AggregatedListAddressesRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteAddressRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteAddressRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 (AddressesClient addressesClient = AddressesClient.create()) {
   DeleteAddressRequest request =
       DeleteAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = addressesClient.deleteAsync(request).get();
 }
 

Parameter
Name	Description
request	DeleteAddressRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String address)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, 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 (AddressesClient addressesClient = AddressesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String address = "address-1147692044";
   Operation response = addressesClient.deleteAsync(project, region, address).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
address	String Name of the address resource to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteAddressRequest,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 (AddressesClient addressesClient = AddressesClient.create()) {
   DeleteAddressRequest request =
       DeleteAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = addressesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteAddressRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteAddressRequest,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 (AddressesClient addressesClient = AddressesClient.create()) {
   DeleteAddressRequest request =
       DeleteAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       addressesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteAddressRequest,Operation,Operation>

get(GetAddressRequest request)

public final Address get(GetAddressRequest 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 (AddressesClient addressesClient = AddressesClient.create()) {
   GetAddressRequest request =
       GetAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   Address response = addressesClient.get(request);
 }
 

Parameter
Name	Description
request	GetAddressRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Address

get(String project, String region, String address)

public final Address get(String project, String region, 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 (AddressesClient addressesClient = AddressesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String address = "address-1147692044";
   Address response = addressesClient.get(project, region, address);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
address	String Name of the address resource to return.

Returns
Type	Description
Address

getCallable()

public final UnaryCallable<GetAddressRequest,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 (AddressesClient addressesClient = AddressesClient.create()) {
   GetAddressRequest request =
       GetAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<Address> future = addressesClient.getCallable().futureCall(request);
   // Do something.
   Address response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetAddressRequest,Address>

getSettings()

public final AddressesSettings getSettings()

Returns
Type	Description
AddressesSettings

getStub()

public AddressesStub getStub()

Returns
Type	Description
AddressesStub

insertAsync(InsertAddressRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertAddressRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 (AddressesClient addressesClient = AddressesClient.create()) {
   InsertAddressRequest request =
       InsertAddressRequest.newBuilder()
           .setAddressResource(Address.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = addressesClient.insertAsync(request).get();
 }
 

Parameter
Name	Description
request	InsertAddressRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, Address addressResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, 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 (AddressesClient addressesClient = AddressesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   Address addressResource = Address.newBuilder().build();
   Operation response = addressesClient.insertAsync(project, region, addressResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
addressResource	Address The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertAddressRequest,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 (AddressesClient addressesClient = AddressesClient.create()) {
   InsertAddressRequest request =
       InsertAddressRequest.newBuilder()
           .setAddressResource(Address.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = addressesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<InsertAddressRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertAddressRequest,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 (AddressesClient addressesClient = AddressesClient.create()) {
   InsertAddressRequest request =
       InsertAddressRequest.newBuilder()
           .setAddressResource(Address.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       addressesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<InsertAddressRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListAddressesRequest request)

public final AddressesClient.ListPagedResponse list(ListAddressesRequest request)

Retrieves a list of addresses contained within the specified region.

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 (AddressesClient addressesClient = AddressesClient.create()) {
   ListAddressesRequest request =
       ListAddressesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (Address element : addressesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListAddressesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
AddressesClient.ListPagedResponse

list(String project, String region)

public final AddressesClient.ListPagedResponse list(String project, String region)

Retrieves a list of addresses contained within the specified region.

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 (AddressesClient addressesClient = AddressesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (Address element : addressesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.

Returns
Type	Description
AddressesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListAddressesRequest,AddressList> listCallable()

Retrieves a list of addresses contained within the specified region.

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 (AddressesClient addressesClient = AddressesClient.create()) {
   ListAddressesRequest request =
       ListAddressesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     AddressList response = addressesClient.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;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListAddressesRequest,AddressList>

listPagedCallable()

public final UnaryCallable<ListAddressesRequest,AddressesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of addresses contained within the specified region.

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

Returns
Type	Description
UnaryCallable<ListAddressesRequest,ListPagedResponse>

moveAsync(MoveAddressRequest request)

public final OperationFuture<Operation,Operation> moveAsync(MoveAddressRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Moves 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 (AddressesClient addressesClient = AddressesClient.create()) {
   MoveAddressRequest request =
       MoveAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionAddressesMoveRequestResource(
               RegionAddressesMoveRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Operation response = addressesClient.moveAsync(request).get();
 }
 

Parameter
Name	Description
request	MoveAddressRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

moveAsync(String project, String region, String address, RegionAddressesMoveRequest regionAddressesMoveRequestResource)

public final OperationFuture<Operation,Operation> moveAsync(String project, String region, String address, RegionAddressesMoveRequest regionAddressesMoveRequestResource)

Moves 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 (AddressesClient addressesClient = AddressesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String address = "address-1147692044";
   RegionAddressesMoveRequest regionAddressesMoveRequestResource =
       RegionAddressesMoveRequest.newBuilder().build();
   Operation response =
       addressesClient
           .moveAsync(project, region, address, regionAddressesMoveRequestResource)
           .get();
 }
 

Parameters
Name	Description
project	String Source project ID which the Address is moved from.
region	String Name of the region for this request.
address	String Name of the address resource to move.
regionAddressesMoveRequestResource	RegionAddressesMoveRequest The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

moveCallable()

public final UnaryCallable<MoveAddressRequest,Operation> moveCallable()

Moves 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 (AddressesClient addressesClient = AddressesClient.create()) {
   MoveAddressRequest request =
       MoveAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionAddressesMoveRequestResource(
               RegionAddressesMoveRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = addressesClient.moveCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<MoveAddressRequest,Operation>

moveOperationCallable()

public final OperationCallable<MoveAddressRequest,Operation,Operation> moveOperationCallable()

Moves 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 (AddressesClient addressesClient = AddressesClient.create()) {
   MoveAddressRequest request =
       MoveAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionAddressesMoveRequestResource(
               RegionAddressesMoveRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       addressesClient.moveOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<MoveAddressRequest,Operation,Operation>

setLabelsAsync(SetLabelsAddressRequest request)

public final OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsAddressRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Sets the labels on an Address. 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 (AddressesClient addressesClient = AddressesClient.create()) {
   SetLabelsAddressRequest request =
       SetLabelsAddressRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   Operation response = addressesClient.setLabelsAsync(request).get();
 }
 

Parameter
Name	Description
request	SetLabelsAddressRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)

public final OperationFuture<Operation,Operation> setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)

Sets the labels on an Address. 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 (AddressesClient addressesClient = AddressesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   RegionSetLabelsRequest regionSetLabelsRequestResource =
       RegionSetLabelsRequest.newBuilder().build();
   Operation response =
       addressesClient
           .setLabelsAsync(project, region, resource, regionSetLabelsRequestResource)
           .get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The region for this request.
resource	String Name or id of the resource for this request.
regionSetLabelsRequestResource	RegionSetLabelsRequest The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

setLabelsCallable()

public final UnaryCallable<SetLabelsAddressRequest,Operation> setLabelsCallable()

Sets the labels on an Address. 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 (AddressesClient addressesClient = AddressesClient.create()) {
   SetLabelsAddressRequest request =
       SetLabelsAddressRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Operation> future = addressesClient.setLabelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<SetLabelsAddressRequest,Operation>

setLabelsOperationCallable()

public final OperationCallable<SetLabelsAddressRequest,Operation,Operation> setLabelsOperationCallable()

Sets the labels on an Address. 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 (AddressesClient addressesClient = AddressesClient.create()) {
   SetLabelsAddressRequest request =
       SetLabelsAddressRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   OperationFuture<Operation, Operation> future =
       addressesClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<SetLabelsAddressRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()