Class GlobalAddressesClient (1.9.1)

Version 1.9.1

• 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

public class GlobalAddressesClient implements 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:

 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:

 GlobalAddressesSettings globalAddressesSettings =
     GlobalAddressesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GlobalAddressesClient globalAddressesClient =
     GlobalAddressesClient.create(globalAddressesSettings);
 

To customize the endpoint:

 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.

Inheritance

java.lang.Object > GlobalAddressesClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final GlobalAddressesClient create()

Constructs an instance of GlobalAddressesClient with default settings.

Returns

Type	Description
GlobalAddressesClient

Exceptions

Type	Description
IOException

create(GlobalAddressesSettings settings)

public static final GlobalAddressesClient create(GlobalAddressesSettings settings)

Constructs an instance of GlobalAddressesClient, 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	GlobalAddressesSettings

Returns

Type	Description
GlobalAddressesClient

Exceptions

Type	Description
IOException

create(GlobalAddressesStub stub)

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).

Parameter

Name	Description
stub	GlobalAddressesStub

Returns

Type	Description
GlobalAddressesClient

Constructors

GlobalAddressesClient(GlobalAddressesSettings settings)

protected GlobalAddressesClient(GlobalAddressesSettings settings)

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.

Parameter

Name	Description
settings	GlobalAddressesSettings

GlobalAddressesClient(GlobalAddressesStub stub)

protected GlobalAddressesClient(GlobalAddressesStub stub)

Parameter

Name	Description
stub	GlobalAddressesStub

Methods

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(DeleteGlobalAddressRequest request)

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

Deletes the specified address resource.

Sample code:

 try (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
   DeleteGlobalAddressRequest request =
       DeleteGlobalAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = globalAddressesClient.deleteAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String address)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String address)

Deletes the specified address resource.

Sample code:

 try (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
   String project = "project-309310695";
   String address = "address-1147692044";
   Operation response = globalAddressesClient.deleteAsync(project, address).get();
 }
 

Parameters

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteGlobalAddressRequest,Operation> deleteCallable()

Deletes the specified address resource.

Sample code:

 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();
 }
 

Returns

Type	Description
UnaryCallable<DeleteGlobalAddressRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteGlobalAddressRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified address resource.

Sample code:

 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();
 }
 

Returns

Type	Description
OperationCallable<DeleteGlobalAddressRequest,Operation,Operation>

get(GetGlobalAddressRequest request)

public final Address get(GetGlobalAddressRequest request)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Sample code:

 try (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
   GetGlobalAddressRequest request =
       GetGlobalAddressRequest.newBuilder()
           .setAddress("address-1147692044")
           .setProject("project-309310695")
           .build();
   Address response = globalAddressesClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
Address

get(String project, String address)

public final Address get(String project, String address)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Sample code:

 try (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
   String project = "project-309310695";
   String address = "address-1147692044";
   Address response = globalAddressesClient.get(project, address);
 }
 

Parameters

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

Returns

Type	Description
Address

getCallable()

public final UnaryCallable<GetGlobalAddressRequest,Address> getCallable()

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Sample code:

 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();
 }
 

Returns

Type	Description
UnaryCallable<GetGlobalAddressRequest,Address>

getSettings()

public final GlobalAddressesSettings getSettings()

Returns

Type	Description
GlobalAddressesSettings

getStub()

public GlobalAddressesStub getStub()

Returns

Type	Description
GlobalAddressesStub

insertAsync(InsertGlobalAddressRequest request)

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

Creates an address resource in the specified project by using the data included in the request.

Sample code:

 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, Address addressResource)

public final 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:

 try (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
   String project = "project-309310695";
   Address addressResource = Address.newBuilder().build();
   Operation response = globalAddressesClient.insertAsync(project, addressResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
addressResource	Address The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertGlobalAddressRequest,Operation> insertCallable()

Creates an address resource in the specified project by using the data included in the request.

Sample code:

 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();
 }
 

Returns

Type	Description
UnaryCallable<InsertGlobalAddressRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertGlobalAddressRequest,Operation,Operation> insertOperationCallable()

Creates an address resource in the specified project by using the data included in the request.

Sample code:

 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();
 }
 

Returns

Type	Description
OperationCallable<InsertGlobalAddressRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListGlobalAddressesRequest request)

public final GlobalAddressesClient.ListPagedResponse list(ListGlobalAddressesRequest request)

Retrieves a list of global addresses.

Sample code:

 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);
   }
 }
 

Parameter

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

Returns

Type	Description
GlobalAddressesClient.ListPagedResponse

list(String project)

public final GlobalAddressesClient.ListPagedResponse list(String project)

Retrieves a list of global addresses.

Sample code:

 try (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
   String project = "project-309310695";
   for (Address element : globalAddressesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
GlobalAddressesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListGlobalAddressesRequest,AddressList> listCallable()

Retrieves a list of global addresses.

Sample code:

 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListGlobalAddressesRequest,AddressList>

listPagedCallable()

public final UnaryCallable<ListGlobalAddressesRequest,GlobalAddressesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of global addresses.

Sample code:

 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);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListGlobalAddressesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()