Class AddressesClient
- java.lang.Object
-
- com.google.cloud.compute.v1.AddressesClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class AddressesClient extends Object implements com.google.api.gax.core.BackgroundResource
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:
- 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.
- 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.
- 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AddressesClient.AggregatedListFixedSizeCollection
static class
AddressesClient.AggregatedListPage
static class
AddressesClient.AggregatedListPagedResponse
static class
AddressesClient.ListFixedSizeCollection
static class
AddressesClient.ListPage
static class
AddressesClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
AddressesClient(AddressesSettings settings)
Constructs an instance of AddressesClient, using the given settings.protected
AddressesClient(AddressesStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddressesClient.AggregatedListPagedResponse
aggregatedList(AggregatedListAddressesRequest request)
Retrieves an aggregated list of addresses.AddressesClient.AggregatedListPagedResponse
aggregatedList(String project)
Retrieves an aggregated list of addresses.com.google.api.gax.rpc.UnaryCallable<AggregatedListAddressesRequest,AddressAggregatedList>
aggregatedListCallable()
Retrieves an aggregated list of addresses.com.google.api.gax.rpc.UnaryCallable<AggregatedListAddressesRequest,AddressesClient.AggregatedListPagedResponse>
aggregatedListPagedCallable()
Retrieves an aggregated list of addresses.boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static AddressesClient
create()
Constructs an instance of AddressesClient with default settings.static AddressesClient
create(AddressesSettings settings)
Constructs an instance of AddressesClient, using the given settings.static AddressesClient
create(AddressesStub stub)
Constructs an instance of AddressesClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteAddressRequest request)
Deletes the specified address resource.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String region, String address)
Deletes the specified address resource.com.google.api.gax.rpc.UnaryCallable<DeleteAddressRequest,Operation>
deleteCallable()
Deletes the specified address resource.com.google.api.gax.rpc.OperationCallable<DeleteAddressRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified address resource.Address
get(GetAddressRequest request)
Returns the specified address resource.Address
get(String project, String region, String address)
Returns the specified address resource.com.google.api.gax.rpc.UnaryCallable<GetAddressRequest,Address>
getCallable()
Returns the specified address resource.AddressesSettings
getSettings()
AddressesStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertAddressRequest request)
Creates an address resource in the specified project by using the data included in the request.com.google.api.gax.longrunning.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.com.google.api.gax.rpc.UnaryCallable<InsertAddressRequest,Operation>
insertCallable()
Creates an address resource in the specified project by using the data included in the request.com.google.api.gax.rpc.OperationCallable<InsertAddressRequest,Operation,Operation>
insertOperationCallable()
Creates an address resource in the specified project by using the data included in the request.boolean
isShutdown()
boolean
isTerminated()
AddressesClient.ListPagedResponse
list(ListAddressesRequest request)
Retrieves a list of addresses contained within the specified region.AddressesClient.ListPagedResponse
list(String project, String region)
Retrieves a list of addresses contained within the specified region.com.google.api.gax.rpc.UnaryCallable<ListAddressesRequest,AddressList>
listCallable()
Retrieves a list of addresses contained within the specified region.com.google.api.gax.rpc.UnaryCallable<ListAddressesRequest,AddressesClient.ListPagedResponse>
listPagedCallable()
Retrieves a list of addresses contained within the specified region.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
moveAsync(MoveAddressRequest request)
Moves the specified address resource.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
moveAsync(String project, String region, String address, RegionAddressesMoveRequest regionAddressesMoveRequestResource)
Moves the specified address resource.com.google.api.gax.rpc.UnaryCallable<MoveAddressRequest,Operation>
moveCallable()
Moves the specified address resource.com.google.api.gax.rpc.OperationCallable<MoveAddressRequest,Operation,Operation>
moveOperationCallable()
Moves the specified address resource.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
setLabelsAsync(SetLabelsAddressRequest request)
Sets the labels on an Address.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)
Sets the labels on an Address.com.google.api.gax.rpc.UnaryCallable<SetLabelsAddressRequest,Operation>
setLabelsCallable()
Sets the labels on an Address.com.google.api.gax.rpc.OperationCallable<SetLabelsAddressRequest,Operation,Operation>
setLabelsOperationCallable()
Sets the labels on an Address.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
AddressesClient
protected AddressesClient(AddressesSettings settings) throws IOException
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.- Throws:
IOException
-
AddressesClient
protected AddressesClient(AddressesStub stub)
-
-
Method Detail
-
create
public static final AddressesClient create() throws IOException
Constructs an instance of AddressesClient with default settings.- Throws:
IOException
-
create
public static final AddressesClient create(AddressesSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final AddressesSettings getSettings()
-
getStub
public AddressesStub getStub()
-
aggregatedList
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); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
aggregatedList
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); } }
- 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
-
aggregatedListPagedCallable
public final com.google.api.gax.rpc.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); } }
-
aggregatedListCallable
public final com.google.api.gax.rpc.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; } } }
-
deleteAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.region
- Name of the region 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(DeleteAddressRequest 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 (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(); }
- 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<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(); }
-
deleteCallable
public final com.google.api.gax.rpc.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(); }
-
get
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:
project
- Project ID for this request.region
- Name of the region 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(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); }
- 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<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(); }
-
insertAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.region
- Name of the region 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(InsertAddressRequest 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 (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(); }
- 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<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(); }
-
insertCallable
public final com.google.api.gax.rpc.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(); }
-
list
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:
project
- Project ID for this request.region
- Name of the region for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
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); } }
- 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<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); } }
-
listCallable
public final com.google.api.gax.rpc.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; } } }
-
moveAsync
public final com.google.api.gax.longrunning.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:
project
- Source project ID which the Address is moved from.region
- Name of the region for this request.address
- Name of the address resource to move.regionAddressesMoveRequestResource
- 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(MoveAddressRequest request)
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(); }
- 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<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(); }
-
moveCallable
public final com.google.api.gax.rpc.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(); }
-
setLabelsAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.region
- The region for this request.resource
- Name or id of the resource for this request.regionSetLabelsRequestResource
- 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(SetLabelsAddressRequest request)
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(); }
- 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<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(); }
-
setLabelsCallable
public final com.google.api.gax.rpc.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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-