Class RegionTargetTcpProxiesClient (1.40.0)

Service Description: The RegionTargetTcpProxies 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetTcpProxy = "targetTcpProxy-337144898";
   TargetTcpProxy response = regionTargetTcpProxiesClient.get(project, region, targetTcpProxy);
 }

Note: close() needs to be called on the RegionTargetTcpProxiesClient 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 RegionTargetTcpProxiesSettings 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
 RegionTargetTcpProxiesSettings regionTargetTcpProxiesSettings =
     RegionTargetTcpProxiesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create(regionTargetTcpProxiesSettings);

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
 RegionTargetTcpProxiesSettings regionTargetTcpProxiesSettings =
     RegionTargetTcpProxiesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create(regionTargetTcpProxiesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > RegionTargetTcpProxiesClient

Static Methods

create()

public static final RegionTargetTcpProxiesClient create()

Constructs an instance of RegionTargetTcpProxiesClient with default settings.

Returns
Type	Description
`RegionTargetTcpProxiesClient`

Exceptions
Type	Description
`IOException`

create(RegionTargetTcpProxiesSettings settings)

public static final RegionTargetTcpProxiesClient create(RegionTargetTcpProxiesSettings settings)

Constructs an instance of RegionTargetTcpProxiesClient, 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`	`RegionTargetTcpProxiesSettings`

Returns
Type	Description
`RegionTargetTcpProxiesClient`

Exceptions
Type	Description
`IOException`

create(RegionTargetTcpProxiesStub stub)

public static final RegionTargetTcpProxiesClient create(RegionTargetTcpProxiesStub stub)

Constructs an instance of RegionTargetTcpProxiesClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionTargetTcpProxiesSettings).

Parameter
Name	Description
`stub`	`RegionTargetTcpProxiesStub`

Returns
Type	Description
`RegionTargetTcpProxiesClient`

Constructors

RegionTargetTcpProxiesClient(RegionTargetTcpProxiesSettings settings)

protected RegionTargetTcpProxiesClient(RegionTargetTcpProxiesSettings settings)

Constructs an instance of RegionTargetTcpProxiesClient, 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`	`RegionTargetTcpProxiesSettings`

RegionTargetTcpProxiesClient(RegionTargetTcpProxiesStub stub)

protected RegionTargetTcpProxiesClient(RegionTargetTcpProxiesStub stub)

Parameter
Name	Description
`stub`	`RegionTargetTcpProxiesStub`

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(DeleteRegionTargetTcpProxyRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionTargetTcpProxyRequest request)

Deletes the specified TargetTcpProxy 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   DeleteRegionTargetTcpProxyRequest request =
       DeleteRegionTargetTcpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetTcpProxy("targetTcpProxy-337144898")
           .build();
   Operation response = regionTargetTcpProxiesClient.deleteAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteRegionTargetTcpProxyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

deleteAsync(String project, String region, String targetTcpProxy)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String targetTcpProxy)

Deletes the specified TargetTcpProxy 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetTcpProxy = "targetTcpProxy-337144898";
   Operation response =
       regionTargetTcpProxiesClient.deleteAsync(project, region, targetTcpProxy).get();
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region scoping this request.
`targetTcpProxy`	`String` Name of the TargetTcpProxy resource to delete.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

deleteCallable()

public final UnaryCallable<DeleteRegionTargetTcpProxyRequest,Operation> deleteCallable()

Deletes the specified TargetTcpProxy 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   DeleteRegionTargetTcpProxyRequest request =
       DeleteRegionTargetTcpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetTcpProxy("targetTcpProxy-337144898")
           .build();
   ApiFuture<Operation> future =
       regionTargetTcpProxiesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteRegionTargetTcpProxyRequest,Operation>`

deleteOperationCallable()

public final OperationCallable<DeleteRegionTargetTcpProxyRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified TargetTcpProxy 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   DeleteRegionTargetTcpProxyRequest request =
       DeleteRegionTargetTcpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetTcpProxy("targetTcpProxy-337144898")
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetTcpProxiesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteRegionTargetTcpProxyRequest,Operation,Operation>`

get(GetRegionTargetTcpProxyRequest request)

public final TargetTcpProxy get(GetRegionTargetTcpProxyRequest request)

Returns the specified TargetTcpProxy 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   GetRegionTargetTcpProxyRequest request =
       GetRegionTargetTcpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetTcpProxy("targetTcpProxy-337144898")
           .build();
   TargetTcpProxy response = regionTargetTcpProxiesClient.get(request);
 }

Parameter
Name	Description
`request`	`GetRegionTargetTcpProxyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TargetTcpProxy`

get(String project, String region, String targetTcpProxy)

public final TargetTcpProxy get(String project, String region, String targetTcpProxy)

Returns the specified TargetTcpProxy 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetTcpProxy = "targetTcpProxy-337144898";
   TargetTcpProxy response = regionTargetTcpProxiesClient.get(project, region, targetTcpProxy);
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region scoping this request.
`targetTcpProxy`	`String` Name of the TargetTcpProxy resource to return.

Returns
Type	Description
`TargetTcpProxy`

getCallable()

public final UnaryCallable<GetRegionTargetTcpProxyRequest,TargetTcpProxy> getCallable()

Returns the specified TargetTcpProxy 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   GetRegionTargetTcpProxyRequest request =
       GetRegionTargetTcpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetTcpProxy("targetTcpProxy-337144898")
           .build();
   ApiFuture<TargetTcpProxy> future =
       regionTargetTcpProxiesClient.getCallable().futureCall(request);
   // Do something.
   TargetTcpProxy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRegionTargetTcpProxyRequest,TargetTcpProxy>`

getSettings()

public final RegionTargetTcpProxiesSettings getSettings()

Returns
Type	Description
`RegionTargetTcpProxiesSettings`

getStub()

public RegionTargetTcpProxiesStub getStub()

Returns
Type	Description
`RegionTargetTcpProxiesStub`

insertAsync(InsertRegionTargetTcpProxyRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRegionTargetTcpProxyRequest request)

Creates a TargetTcpProxy resource in the specified project and region 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   InsertRegionTargetTcpProxyRequest request =
       InsertRegionTargetTcpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetTcpProxyResource(TargetTcpProxy.newBuilder().build())
           .build();
   Operation response = regionTargetTcpProxiesClient.insertAsync(request).get();
 }

Parameter
Name	Description
`request`	`InsertRegionTargetTcpProxyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

insertAsync(String project, String region, TargetTcpProxy targetTcpProxyResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, TargetTcpProxy targetTcpProxyResource)

Creates a TargetTcpProxy resource in the specified project and region 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   TargetTcpProxy targetTcpProxyResource = TargetTcpProxy.newBuilder().build();
   Operation response =
       regionTargetTcpProxiesClient.insertAsync(project, region, targetTcpProxyResource).get();
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region scoping this request.
`targetTcpProxyResource`	`TargetTcpProxy` The body resource for this request

Returns
Type	Description
`OperationFuture<Operation,Operation>`

insertCallable()

public final UnaryCallable<InsertRegionTargetTcpProxyRequest,Operation> insertCallable()

Creates a TargetTcpProxy resource in the specified project and region 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   InsertRegionTargetTcpProxyRequest request =
       InsertRegionTargetTcpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetTcpProxyResource(TargetTcpProxy.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       regionTargetTcpProxiesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<InsertRegionTargetTcpProxyRequest,Operation>`

insertOperationCallable()

public final OperationCallable<InsertRegionTargetTcpProxyRequest,Operation,Operation> insertOperationCallable()

Creates a TargetTcpProxy resource in the specified project and region 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   InsertRegionTargetTcpProxyRequest request =
       InsertRegionTargetTcpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetTcpProxyResource(TargetTcpProxy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetTcpProxiesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`OperationCallable<InsertRegionTargetTcpProxyRequest,Operation,Operation>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

list(ListRegionTargetTcpProxiesRequest request)

public final RegionTargetTcpProxiesClient.ListPagedResponse list(ListRegionTargetTcpProxiesRequest request)

Retrieves a list of TargetTcpProxy resources available to the specified project in a given 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   ListRegionTargetTcpProxiesRequest request =
       ListRegionTargetTcpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (TargetTcpProxy element : regionTargetTcpProxiesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRegionTargetTcpProxiesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RegionTargetTcpProxiesClient.ListPagedResponse`

list(String project, String region)

public final RegionTargetTcpProxiesClient.ListPagedResponse list(String project, String region)

Retrieves a list of TargetTcpProxy resources available to the specified project in a given 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (TargetTcpProxy element :
       regionTargetTcpProxiesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region scoping this request.

Returns
Type	Description
`RegionTargetTcpProxiesClient.ListPagedResponse`

listCallable()

public final UnaryCallable<ListRegionTargetTcpProxiesRequest,TargetTcpProxyList> listCallable()

Retrieves a list of TargetTcpProxy resources available to the specified project in a given 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   ListRegionTargetTcpProxiesRequest request =
       ListRegionTargetTcpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetTcpProxyList response = regionTargetTcpProxiesClient.listCallable().call(request);
     for (TargetTcpProxy 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<ListRegionTargetTcpProxiesRequest,TargetTcpProxyList>`

listPagedCallable()

public final UnaryCallable<ListRegionTargetTcpProxiesRequest,RegionTargetTcpProxiesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of TargetTcpProxy resources available to the specified project in a given 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 (RegionTargetTcpProxiesClient regionTargetTcpProxiesClient =
     RegionTargetTcpProxiesClient.create()) {
   ListRegionTargetTcpProxiesRequest request =
       ListRegionTargetTcpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<TargetTcpProxy> future =
       regionTargetTcpProxiesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (TargetTcpProxy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRegionTargetTcpProxiesRequest,ListPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()