AddressClient (Google Cloud 0.119.0-alpha API)

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

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class AddressClient
extends Object
implements com.google.api.gax.core.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 (AddressClient addressClient = AddressClient.create()) {
   ProjectRegionAddressName address = ProjectRegionAddressName.of("[PROJECT]", "[REGION]", "[ADDRESS]");
   Operation response = addressClient.deleteAddress(address);
 }
 
 
```
Note: close() needs to be called on the addressClient 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 AddressSettings to create(). For example:
To customize credentials:
```
 
 AddressSettings addressSettings =
     AddressSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AddressClient addressClient =
     AddressClient.create(addressSettings);
 
 
```
To customize the endpoint:
```
 
 AddressSettings addressSettings =
     AddressSettings.newBuilder().setEndpoint(myEndpoint).build();
 AddressClient addressClient =
     AddressClient.create(addressSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AddressClient.AggregatedListAddressesFixedSizeCollection`
`static class`	`AddressClient.AggregatedListAddressesPage`
`static class`	`AddressClient.AggregatedListAddressesPagedResponse`
`static class`	`AddressClient.ListAddressesFixedSizeCollection`
`static class`	`AddressClient.ListAddressesPage`
`static class`	`AddressClient.ListAddressesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AddressClient(AddressSettings settings)` Constructs an instance of AddressClient, using the given settings.
`protected`	`AddressClient(AddressStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddressClient.AggregatedListAddressesPagedResponse`	`aggregatedListAddresses(AggregatedListAddressesHttpRequest request)` Retrieves an aggregated list of addresses.
`AddressClient.AggregatedListAddressesPagedResponse`	`aggregatedListAddresses(ProjectName project)` Retrieves an aggregated list of addresses.
`AddressClient.AggregatedListAddressesPagedResponse`	`aggregatedListAddresses(String project)` Retrieves an aggregated list of addresses.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListAddressesHttpRequest,AddressAggregatedList>`	`aggregatedListAddressesCallable()` Retrieves an aggregated list of addresses.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListAddressesHttpRequest,AddressClient.AggregatedListAddressesPagedResponse>`	`aggregatedListAddressesPagedCallable()` Retrieves an aggregated list of addresses.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static AddressClient`	`create()` Constructs an instance of AddressClient with default settings.
`static AddressClient`	`create(AddressSettings settings)` Constructs an instance of AddressClient, using the given settings.
`static AddressClient`	`create(AddressStub stub)` Constructs an instance of AddressClient, using the given stub for making calls.
`Operation`	`deleteAddress(DeleteAddressHttpRequest request)` Deletes the specified address resource.
`Operation`	`deleteAddress(ProjectRegionAddressName address)` Deletes the specified address resource.
`Operation`	`deleteAddress(String address)` Deletes the specified address resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteAddressHttpRequest,Operation>`	`deleteAddressCallable()` Deletes the specified address resource.
`Address`	`getAddress(GetAddressHttpRequest request)` Returns the specified address resource.
`Address`	`getAddress(ProjectRegionAddressName address)` Returns the specified address resource.
`Address`	`getAddress(String address)` Returns the specified address resource.
`com.google.api.gax.rpc.UnaryCallable<GetAddressHttpRequest,Address>`	`getAddressCallable()` Returns the specified address resource.
`AddressSettings`	`getSettings()`
`AddressStub`	`getStub()`
`Operation`	`insertAddress(InsertAddressHttpRequest request)` Creates an address resource in the specified project by using the data included in the request.
`Operation`	`insertAddress(ProjectRegionName region, Address addressResource)` Creates an address resource in the specified project by using the data included in the request.
`Operation`	`insertAddress(String region, Address addressResource)` Creates an address resource in the specified project by using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertAddressHttpRequest,Operation>`	`insertAddressCallable()` Creates an address resource in the specified project by using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`AddressClient.ListAddressesPagedResponse`	`listAddresses(ListAddressesHttpRequest request)` Retrieves a list of addresses contained within the specified region.
`AddressClient.ListAddressesPagedResponse`	`listAddresses(ProjectRegionName region)` Retrieves a list of addresses contained within the specified region.
`AddressClient.ListAddressesPagedResponse`	`listAddresses(String region)` Retrieves a list of addresses contained within the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListAddressesHttpRequest,AddressList>`	`listAddressesCallable()` Retrieves a list of addresses contained within the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListAddressesHttpRequest,AddressClient.ListAddressesPagedResponse>`	`listAddressesPagedCallable()` Retrieves a list of addresses contained within the specified region.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

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

Method Detail

create

public static final AddressClient create()
                                  throws IOException

Constructs an instance of AddressClient with default settings.

Throws:: IOException

create
```
public static final AddressClient create(AddressSettings settings)
                                  throws IOException
```
Constructs an instance of AddressClient, 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 AddressClient create(AddressStub stub)

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

getSettings

public final AddressSettings getSettings()