- 1.58.0 (latest)
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class TargetVpnGatewaysClient implements BackgroundResource
Service Description: The TargetVpnGateways API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String targetVpnGateway = "targetVpnGateway935274273";
TargetVpnGateway response = targetVpnGatewaysClient.get(project, region, targetVpnGateway);
}
Note: close() needs to be called on the TargetVpnGatewaysClient 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 TargetVpnGatewaysSettings to create(). For example:
To customize credentials:
TargetVpnGatewaysSettings targetVpnGatewaysSettings =
TargetVpnGatewaysSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
TargetVpnGatewaysClient targetVpnGatewaysClient =
TargetVpnGatewaysClient.create(targetVpnGatewaysSettings);
To customize the endpoint:
TargetVpnGatewaysSettings targetVpnGatewaysSettings =
TargetVpnGatewaysSettings.newBuilder().setEndpoint(myEndpoint).build();
TargetVpnGatewaysClient targetVpnGatewaysClient =
TargetVpnGatewaysClient.create(targetVpnGatewaysSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final TargetVpnGatewaysClient create()
Constructs an instance of TargetVpnGatewaysClient with default settings.
Type | Description |
TargetVpnGatewaysClient |
Type | Description |
IOException |
create(TargetVpnGatewaysSettings settings)
public static final TargetVpnGatewaysClient create(TargetVpnGatewaysSettings settings)
Constructs an instance of TargetVpnGatewaysClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | TargetVpnGatewaysSettings |
Type | Description |
TargetVpnGatewaysClient |
Type | Description |
IOException |
create(TargetVpnGatewaysStub stub)
public static final TargetVpnGatewaysClient create(TargetVpnGatewaysStub stub)
Constructs an instance of TargetVpnGatewaysClient, using the given stub for making calls. This is for advanced usage - prefer using create(TargetVpnGatewaysSettings).
Name | Description |
stub | TargetVpnGatewaysStub |
Type | Description |
TargetVpnGatewaysClient |
Constructors
TargetVpnGatewaysClient(TargetVpnGatewaysSettings settings)
protected TargetVpnGatewaysClient(TargetVpnGatewaysSettings settings)
Constructs an instance of TargetVpnGatewaysClient, 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.
Name | Description |
settings | TargetVpnGatewaysSettings |
TargetVpnGatewaysClient(TargetVpnGatewaysStub stub)
protected TargetVpnGatewaysClient(TargetVpnGatewaysStub stub)
Name | Description |
stub | TargetVpnGatewaysStub |
Methods
aggregatedList(AggregatedListTargetVpnGatewaysRequest request)
public final TargetVpnGatewaysClient.AggregatedListPagedResponse aggregatedList(AggregatedListTargetVpnGatewaysRequest request)
Retrieves an aggregated list of target VPN gateways.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
AggregatedListTargetVpnGatewaysRequest request =
AggregatedListTargetVpnGatewaysRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
for (Map.Entry
Name | Description |
request | AggregatedListTargetVpnGatewaysRequest The request object containing all of the parameters for the API call. |
Type | Description |
TargetVpnGatewaysClient.AggregatedListPagedResponse |
aggregatedList(String project)
public final TargetVpnGatewaysClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves an aggregated list of target VPN gateways.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
String project = "project-309310695";
for (Map.Entry
Name | Description |
project | String Project ID for this request. |
Type | Description |
TargetVpnGatewaysClient.AggregatedListPagedResponse |
aggregatedListCallable()
public final UnaryCallable<AggregatedListTargetVpnGatewaysRequest,TargetVpnGatewayAggregatedList> aggregatedListCallable()
Retrieves an aggregated list of target VPN gateways.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
AggregatedListTargetVpnGatewaysRequest request =
AggregatedListTargetVpnGatewaysRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
while (true) {
TargetVpnGatewayAggregatedList response =
targetVpnGatewaysClient.aggregatedListCallable().call(request);
for (Map.Entry
Type | Description |
UnaryCallable<AggregatedListTargetVpnGatewaysRequest,TargetVpnGatewayAggregatedList> |
aggregatedListPagedCallable()
public final UnaryCallable<AggregatedListTargetVpnGatewaysRequest,TargetVpnGatewaysClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves an aggregated list of target VPN gateways.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
AggregatedListTargetVpnGatewaysRequest request =
AggregatedListTargetVpnGatewaysRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
ApiFuture<>
Type | Description |
UnaryCallable<AggregatedListTargetVpnGatewaysRequest,AggregatedListPagedResponse> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
deleteAsync(DeleteTargetVpnGatewayRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteTargetVpnGatewayRequest request)
Deletes the specified target VPN gateway.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
DeleteTargetVpnGatewayRequest request =
DeleteTargetVpnGatewayRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetVpnGateway("targetVpnGateway935274273")
.build();
Operation response = targetVpnGatewaysClient.deleteAsync(request).get();
}
Name | Description |
request | DeleteTargetVpnGatewayRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String region, String targetVpnGateway)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String targetVpnGateway)
Deletes the specified target VPN gateway.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String targetVpnGateway = "targetVpnGateway935274273";
Operation response =
targetVpnGatewaysClient.deleteAsync(project, region, targetVpnGateway).get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
targetVpnGateway | String Name of the target VPN gateway to delete. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteTargetVpnGatewayRequest,Operation> deleteCallable()
Deletes the specified target VPN gateway.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
DeleteTargetVpnGatewayRequest request =
DeleteTargetVpnGatewayRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetVpnGateway("targetVpnGateway935274273")
.build();
ApiFuture<Operation> future = targetVpnGatewaysClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<DeleteTargetVpnGatewayRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteTargetVpnGatewayRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified target VPN gateway.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
DeleteTargetVpnGatewayRequest request =
DeleteTargetVpnGatewayRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetVpnGateway("targetVpnGateway935274273")
.build();
OperationFuture
Type | Description |
OperationCallable<DeleteTargetVpnGatewayRequest,Operation,Operation> |
get(GetTargetVpnGatewayRequest request)
public final TargetVpnGateway get(GetTargetVpnGatewayRequest request)
Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
GetTargetVpnGatewayRequest request =
GetTargetVpnGatewayRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setTargetVpnGateway("targetVpnGateway935274273")
.build();
TargetVpnGateway response = targetVpnGatewaysClient.get(request);
}
Name | Description |
request | GetTargetVpnGatewayRequest The request object containing all of the parameters for the API call. |
Type | Description |
TargetVpnGateway |
get(String project, String region, String targetVpnGateway)
public final TargetVpnGateway get(String project, String region, String targetVpnGateway)
Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String targetVpnGateway = "targetVpnGateway935274273";
TargetVpnGateway response = targetVpnGatewaysClient.get(project, region, targetVpnGateway);
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
targetVpnGateway | String Name of the target VPN gateway to return. |
Type | Description |
TargetVpnGateway |
getCallable()
public final UnaryCallable<GetTargetVpnGatewayRequest,TargetVpnGateway> getCallable()
Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
GetTargetVpnGatewayRequest request =
GetTargetVpnGatewayRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setTargetVpnGateway("targetVpnGateway935274273")
.build();
ApiFuture
Type | Description |
UnaryCallable<GetTargetVpnGatewayRequest,TargetVpnGateway> |
getSettings()
public final TargetVpnGatewaysSettings getSettings()
Type | Description |
TargetVpnGatewaysSettings |
getStub()
public TargetVpnGatewaysStub getStub()
Type | Description |
TargetVpnGatewaysStub |
insertAsync(InsertTargetVpnGatewayRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertTargetVpnGatewayRequest request)
Creates a target VPN gateway in the specified project and region using the data included in the request.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
InsertTargetVpnGatewayRequest request =
InsertTargetVpnGatewayRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetVpnGatewayResource(TargetVpnGateway.newBuilder().build())
.build();
Operation response = targetVpnGatewaysClient.insertAsync(request).get();
}
Name | Description |
request | InsertTargetVpnGatewayRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, String region, TargetVpnGateway targetVpnGatewayResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, String region, TargetVpnGateway targetVpnGatewayResource)
Creates a target VPN gateway in the specified project and region using the data included in the request.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
TargetVpnGateway targetVpnGatewayResource = TargetVpnGateway.newBuilder().build();
Operation response =
targetVpnGatewaysClient.insertAsync(project, region, targetVpnGatewayResource).get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
targetVpnGatewayResource | TargetVpnGateway The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertTargetVpnGatewayRequest,Operation> insertCallable()
Creates a target VPN gateway in the specified project and region using the data included in the request.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
InsertTargetVpnGatewayRequest request =
InsertTargetVpnGatewayRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetVpnGatewayResource(TargetVpnGateway.newBuilder().build())
.build();
ApiFuture<Operation> future = targetVpnGatewaysClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<InsertTargetVpnGatewayRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertTargetVpnGatewayRequest,Operation,Operation> insertOperationCallable()
Creates a target VPN gateway in the specified project and region using the data included in the request.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
InsertTargetVpnGatewayRequest request =
InsertTargetVpnGatewayRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetVpnGatewayResource(TargetVpnGateway.newBuilder().build())
.build();
OperationFuture
Type | Description |
OperationCallable<InsertTargetVpnGatewayRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
list(ListTargetVpnGatewaysRequest request)
public final TargetVpnGatewaysClient.ListPagedResponse list(ListTargetVpnGatewaysRequest request)
Retrieves a list of target VPN gateways available to the specified project and region.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
ListTargetVpnGatewaysRequest request =
ListTargetVpnGatewaysRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
for (TargetVpnGateway element : targetVpnGatewaysClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListTargetVpnGatewaysRequest The request object containing all of the parameters for the API call. |
Type | Description |
TargetVpnGatewaysClient.ListPagedResponse |
list(String project, String region)
public final TargetVpnGatewaysClient.ListPagedResponse list(String project, String region)
Retrieves a list of target VPN gateways available to the specified project and region.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
for (TargetVpnGateway element : targetVpnGatewaysClient.list(project, region).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
Type | Description |
TargetVpnGatewaysClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListTargetVpnGatewaysRequest,TargetVpnGatewayList> listCallable()
Retrieves a list of target VPN gateways available to the specified project and region.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
ListTargetVpnGatewaysRequest request =
ListTargetVpnGatewaysRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
while (true) {
TargetVpnGatewayList response = targetVpnGatewaysClient.listCallable().call(request);
for (TargetVpnGateway element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListTargetVpnGatewaysRequest,TargetVpnGatewayList> |
listPagedCallable()
public final UnaryCallable<ListTargetVpnGatewaysRequest,TargetVpnGatewaysClient.ListPagedResponse> listPagedCallable()
Retrieves a list of target VPN gateways available to the specified project and region.
Sample code:
try (TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.create()) {
ListTargetVpnGatewaysRequest request =
ListTargetVpnGatewaysRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
ApiFuture
Type | Description |
UnaryCallable<ListTargetVpnGatewaysRequest,ListPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()