GlobalAddressClient (Google Cloud 0.90.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.GlobalAddressClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class GlobalAddressClient
extends Object
implements BackgroundResource
```
Service Description: Creates and runs virtual machines on Google Cloud Platform.
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 (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   ProjectGlobalAddressName address = ProjectGlobalAddressName.of("[PROJECT]", "[ADDRESS]");
   Operation response = globalAddressClient.deleteGlobalAddress(address);
 }
 
 
```
Note: close() needs to be called on the globalAddressClient 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 GlobalAddressSettings to create(). For example:
To customize credentials:
```
 
 GlobalAddressSettings globalAddressSettings =
     GlobalAddressSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GlobalAddressClient globalAddressClient =
     GlobalAddressClient.create(globalAddressSettings);
 
 
```
To customize the endpoint:
```
 
 GlobalAddressSettings globalAddressSettings =
     GlobalAddressSettings.newBuilder().setEndpoint(myEndpoint).build();
 GlobalAddressClient globalAddressClient =
     GlobalAddressClient.create(globalAddressSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GlobalAddressClient.ListGlobalAddressesFixedSizeCollection`
`static class`	`GlobalAddressClient.ListGlobalAddressesPage`
`static class`	`GlobalAddressClient.ListGlobalAddressesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GlobalAddressClient(GlobalAddressSettings settings)` Constructs an instance of GlobalAddressClient, using the given settings.
`protected`	`GlobalAddressClient(GlobalAddressStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static GlobalAddressClient`	`create()` Constructs an instance of GlobalAddressClient with default settings.
`static GlobalAddressClient`	`create(GlobalAddressSettings settings)` Constructs an instance of GlobalAddressClient, using the given settings.
`static GlobalAddressClient`	`create(GlobalAddressStub stub)` Constructs an instance of GlobalAddressClient, using the given stub for making calls.
`Operation`	`deleteGlobalAddress(DeleteGlobalAddressHttpRequest request)` Deletes the specified address resource.
`Operation`	`deleteGlobalAddress(ProjectGlobalAddressName address)` Deletes the specified address resource.
`Operation`	`deleteGlobalAddress(String address)` Deletes the specified address resource.
`UnaryCallable<DeleteGlobalAddressHttpRequest,Operation>`	`deleteGlobalAddressCallable()` Deletes the specified address resource.
`Address`	`getGlobalAddress(GetGlobalAddressHttpRequest request)` Returns the specified address resource.
`Address`	`getGlobalAddress(ProjectGlobalAddressName address)` Returns the specified address resource.
`Address`	`getGlobalAddress(String address)` Returns the specified address resource.
`UnaryCallable<GetGlobalAddressHttpRequest,Address>`	`getGlobalAddressCallable()` Returns the specified address resource.
`GlobalAddressSettings`	`getSettings()`
`GlobalAddressStub`	`getStub()`
`Operation`	`insertGlobalAddress(InsertGlobalAddressHttpRequest request)` Creates an address resource in the specified project using the data included in the request.
`Operation`	`insertGlobalAddress(ProjectName project, Address addressResource)` Creates an address resource in the specified project using the data included in the request.
`Operation`	`insertGlobalAddress(String project, Address addressResource)` Creates an address resource in the specified project using the data included in the request.
`UnaryCallable<InsertGlobalAddressHttpRequest,Operation>`	`insertGlobalAddressCallable()` Creates an address resource in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`GlobalAddressClient.ListGlobalAddressesPagedResponse`	`listGlobalAddresses(ListGlobalAddressesHttpRequest request)` Retrieves a list of global addresses.
`GlobalAddressClient.ListGlobalAddressesPagedResponse`	`listGlobalAddresses(ProjectName project)` Retrieves a list of global addresses.
`GlobalAddressClient.ListGlobalAddressesPagedResponse`	`listGlobalAddresses(String project)` Retrieves a list of global addresses.
`UnaryCallable<ListGlobalAddressesHttpRequest,AddressList>`	`listGlobalAddressesCallable()` Retrieves a list of global addresses.
`UnaryCallable<ListGlobalAddressesHttpRequest,GlobalAddressClient.ListGlobalAddressesPagedResponse>`	`listGlobalAddressesPagedCallable()` Retrieves a list of global addresses.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- GlobalAddressClient
```
protected GlobalAddressClient(GlobalAddressSettings settings)
                       throws IOException
```
  Constructs an instance of GlobalAddressClient, 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
- GlobalAddressClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected GlobalAddressClient(GlobalAddressStub stub)
```

Method Detail

create

public static final GlobalAddressClient create()
                                        throws IOException

Constructs an instance of GlobalAddressClient with default settings.

Throws:: IOException

create
```
public static final GlobalAddressClient create(GlobalAddressSettings settings)
                                        throws IOException
```
Constructs an instance of GlobalAddressClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final GlobalAddressClient create(GlobalAddressStub stub)

Constructs an instance of GlobalAddressClient, using the given stub for making calls. This is for advanced usage - prefer to use GlobalAddressSettings}.

getSettings

public final GlobalAddressSettings getSettings()

getStub

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

deleteGlobalAddress

@BetaApi
public final Operation deleteGlobalAddress(ProjectGlobalAddressName address)

Deletes the specified address resource.

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   ProjectGlobalAddressName address = ProjectGlobalAddressName.of("[PROJECT]", "[ADDRESS]");
   Operation response = globalAddressClient.deleteGlobalAddress(address);
 }

Parameters:: address - Name of the address resource to delete.
Throws:: ApiException - if the remote call fails

deleteGlobalAddress

@BetaApi
public final Operation deleteGlobalAddress(String address)

Deletes the specified address resource.

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   ProjectGlobalAddressName address = ProjectGlobalAddressName.of("[PROJECT]", "[ADDRESS]");
   Operation response = globalAddressClient.deleteGlobalAddress(address.toString());
 }

Parameters:: address - Name of the address resource to delete.
Throws:: ApiException - if the remote call fails

deleteGlobalAddress

@BetaApi
public final Operation deleteGlobalAddress(DeleteGlobalAddressHttpRequest request)

Deletes the specified address resource.

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   String formattedAddress = ProjectGlobalAddressName.format("[PROJECT]", "[ADDRESS]");
   DeleteGlobalAddressHttpRequest request = DeleteGlobalAddressHttpRequest.newBuilder()
     .setAddress(formattedAddress)
     .build();
   Operation response = globalAddressClient.deleteGlobalAddress(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteGlobalAddressCallable

@BetaApi
public final UnaryCallable<DeleteGlobalAddressHttpRequest,Operation> deleteGlobalAddressCallable()

Deletes the specified address resource.

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   String formattedAddress = ProjectGlobalAddressName.format("[PROJECT]", "[ADDRESS]");
   DeleteGlobalAddressHttpRequest request = DeleteGlobalAddressHttpRequest.newBuilder()
     .setAddress(formattedAddress)
     .build();
   ApiFuture<Operation> future = globalAddressClient.deleteGlobalAddressCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getGlobalAddress

@BetaApi
public final Address getGlobalAddress(ProjectGlobalAddressName address)

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

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   ProjectGlobalAddressName address = ProjectGlobalAddressName.of("[PROJECT]", "[ADDRESS]");
   Address response = globalAddressClient.getGlobalAddress(address);
 }

Parameters:: address - Name of the address resource to return.
Throws:: ApiException - if the remote call fails

getGlobalAddress

@BetaApi
public final Address getGlobalAddress(String address)

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

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   ProjectGlobalAddressName address = ProjectGlobalAddressName.of("[PROJECT]", "[ADDRESS]");
   Address response = globalAddressClient.getGlobalAddress(address.toString());
 }

Parameters:: address - Name of the address resource to return.
Throws:: ApiException - if the remote call fails

getGlobalAddress

@BetaApi
public final Address getGlobalAddress(GetGlobalAddressHttpRequest request)

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

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   String formattedAddress = ProjectGlobalAddressName.format("[PROJECT]", "[ADDRESS]");
   GetGlobalAddressHttpRequest request = GetGlobalAddressHttpRequest.newBuilder()
     .setAddress(formattedAddress)
     .build();
   Address response = globalAddressClient.getGlobalAddress(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getGlobalAddressCallable

@BetaApi
public final UnaryCallable<GetGlobalAddressHttpRequest,Address> getGlobalAddressCallable()

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

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   String formattedAddress = ProjectGlobalAddressName.format("[PROJECT]", "[ADDRESS]");
   GetGlobalAddressHttpRequest request = GetGlobalAddressHttpRequest.newBuilder()
     .setAddress(formattedAddress)
     .build();
   ApiFuture<Address> future = globalAddressClient.getGlobalAddressCallable().futureCall(request);
   // Do something
   Address response = future.get();
 }

insertGlobalAddress

@BetaApi
public final Operation insertGlobalAddress(ProjectName project,
                                                    Address addressResource)

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

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   Address addressResource = Address.newBuilder().build();
   Operation response = globalAddressClient.insertGlobalAddress(project, addressResource);
 }

Parameters:: project - Project ID for this request.; addressResource - A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)
Throws:: ApiException - if the remote call fails

insertGlobalAddress

@BetaApi
public final Operation insertGlobalAddress(String project,
                                                    Address addressResource)

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

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   Address addressResource = Address.newBuilder().build();
   Operation response = globalAddressClient.insertGlobalAddress(project.toString(), addressResource);
 }

Parameters:: project - Project ID for this request.; addressResource - A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)
Throws:: ApiException - if the remote call fails

insertGlobalAddress

@BetaApi
public final Operation insertGlobalAddress(InsertGlobalAddressHttpRequest request)

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

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   Address addressResource = Address.newBuilder().build();
   InsertGlobalAddressHttpRequest request = InsertGlobalAddressHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setAddressResource(addressResource)
     .build();
   Operation response = globalAddressClient.insertGlobalAddress(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

insertGlobalAddressCallable

@BetaApi
public final UnaryCallable<InsertGlobalAddressHttpRequest,Operation> insertGlobalAddressCallable()

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

Sample code:


 try (GlobalAddressClient globalAddressClient = GlobalAddressClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   Address addressResource = Address.newBuilder().build();
   InsertGlobalAddressHttpRequest request = InsertGlobalAddressHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setAddressResource(addressResource)
     .build();
   ApiFuture<Operation> future = globalAddressClient.insertGlobalAddressCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }