- 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 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:
// 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 (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().
Method | Description | Method Variants |
---|---|---|
Delete | Deletes the specified address resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Get | Returns the specified address resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Insert | Creates an address resource in the specified project by using the data included in the request. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
List | Retrieves a list of global addresses. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Move | Moves the specified address resource from one project to another project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetLabels | Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return 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:
// 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
GlobalAddressesSettings globalAddressesSettings =
GlobalAddressesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
GlobalAddressesClient globalAddressesClient =
GlobalAddressesClient.create(globalAddressesSettings);
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
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.
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:
// 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 (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:
// 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 (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:
// 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 (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:
// 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 (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.
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 (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.
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 (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.
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 (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:
// 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 (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:
// 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 (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:
// 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 (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:
// 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 (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:
// 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 (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:
// 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 (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:
// 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 (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.getItemsList()) {
// 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:
// 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 (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> |
moveAsync(MoveGlobalAddressRequest request)
public final OperationFuture<Operation,Operation> moveAsync(MoveGlobalAddressRequest request)
Moves the specified address resource from one project to another project.
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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
MoveGlobalAddressRequest request =
MoveGlobalAddressRequest.newBuilder()
.setAddress("address-1147692044")
.setGlobalAddressesMoveRequestResource(
GlobalAddressesMoveRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
Operation response = globalAddressesClient.moveAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | MoveGlobalAddressRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
moveAsync(String project, String address, GlobalAddressesMoveRequest globalAddressesMoveRequestResource)
public final OperationFuture<Operation,Operation> moveAsync(String project, String address, GlobalAddressesMoveRequest globalAddressesMoveRequestResource)
Moves the specified address resource from one project to another project.
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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
String project = "project-309310695";
String address = "address-1147692044";
GlobalAddressesMoveRequest globalAddressesMoveRequestResource =
GlobalAddressesMoveRequest.newBuilder().build();
Operation response =
globalAddressesClient
.moveAsync(project, address, globalAddressesMoveRequestResource)
.get();
}
Parameters | |
---|---|
Name | Description |
project | String Source project ID which the Address is moved from. |
address | String Name of the address resource to move. |
globalAddressesMoveRequestResource | GlobalAddressesMoveRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
moveCallable()
public final UnaryCallable<MoveGlobalAddressRequest,Operation> moveCallable()
Moves the specified address resource from one project to another project.
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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
MoveGlobalAddressRequest request =
MoveGlobalAddressRequest.newBuilder()
.setAddress("address-1147692044")
.setGlobalAddressesMoveRequestResource(
GlobalAddressesMoveRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = globalAddressesClient.moveCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<MoveGlobalAddressRequest,Operation> |
moveOperationCallable()
public final OperationCallable<MoveGlobalAddressRequest,Operation,Operation> moveOperationCallable()
Moves the specified address resource from one project to another project.
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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
MoveGlobalAddressRequest request =
MoveGlobalAddressRequest.newBuilder()
.setAddress("address-1147692044")
.setGlobalAddressesMoveRequestResource(
GlobalAddressesMoveRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
globalAddressesClient.moveOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<MoveGlobalAddressRequest,Operation,Operation> |
setLabelsAsync(SetLabelsGlobalAddressRequest request)
public final OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsGlobalAddressRequest request)
Sets the labels on a GlobalAddress. 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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
SetLabelsGlobalAddressRequest request =
SetLabelsGlobalAddressRequest.newBuilder()
.setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
Operation response = globalAddressesClient.setLabelsAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | SetLabelsGlobalAddressRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)
public final OperationFuture<Operation,Operation> setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)
Sets the labels on a GlobalAddress. 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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
String project = "project-309310695";
String resource = "resource-341064690";
GlobalSetLabelsRequest globalSetLabelsRequestResource =
GlobalSetLabelsRequest.newBuilder().build();
Operation response =
globalAddressesClient
.setLabelsAsync(project, resource, globalSetLabelsRequestResource)
.get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
resource | String Name or id of the resource for this request. |
globalSetLabelsRequestResource | GlobalSetLabelsRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
setLabelsCallable()
public final UnaryCallable<SetLabelsGlobalAddressRequest,Operation> setLabelsCallable()
Sets the labels on a GlobalAddress. 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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
SetLabelsGlobalAddressRequest request =
SetLabelsGlobalAddressRequest.newBuilder()
.setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
ApiFuture<Operation> future = globalAddressesClient.setLabelsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetLabelsGlobalAddressRequest,Operation> |
setLabelsOperationCallable()
public final OperationCallable<SetLabelsGlobalAddressRequest,Operation,Operation> setLabelsOperationCallable()
Sets the labels on a GlobalAddress. 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 (GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.create()) {
SetLabelsGlobalAddressRequest request =
SetLabelsGlobalAddressRequest.newBuilder()
.setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
OperationFuture<Operation, Operation> future =
globalAddressesClient.setLabelsOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<SetLabelsGlobalAddressRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()