Class RegionTargetHttpProxiesClient (1.7.2)

Version 1.7.2

• 1.63.0 (latest)
• 1.62.0
• 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

public class RegionTargetHttpProxiesClient implements BackgroundResource

Service Description: The RegionTargetHttpProxies 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   TargetHttpProxy response =
       regionTargetHttpProxiesClient.get(project, region, targetHttpProxy);
 }
 

Note: close() needs to be called on the RegionTargetHttpProxiesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of RegionTargetHttpProxiesSettings to create(). For example:

To customize credentials:

 RegionTargetHttpProxiesSettings regionTargetHttpProxiesSettings =
     RegionTargetHttpProxiesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create(regionTargetHttpProxiesSettings);
 

To customize the endpoint:

 RegionTargetHttpProxiesSettings regionTargetHttpProxiesSettings =
     RegionTargetHttpProxiesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create(regionTargetHttpProxiesSettings);
 

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

Inheritance

java.lang.Object > RegionTargetHttpProxiesClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final RegionTargetHttpProxiesClient create()

Constructs an instance of RegionTargetHttpProxiesClient with default settings.

Returns

Type	Description
RegionTargetHttpProxiesClient

Exceptions

Type	Description
IOException

create(RegionTargetHttpProxiesSettings settings)

public static final RegionTargetHttpProxiesClient create(RegionTargetHttpProxiesSettings settings)

Constructs an instance of RegionTargetHttpProxiesClient, 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	RegionTargetHttpProxiesSettings

Returns

Type	Description
RegionTargetHttpProxiesClient

Exceptions

Type	Description
IOException

create(RegionTargetHttpProxiesStub stub)

public static final RegionTargetHttpProxiesClient create(RegionTargetHttpProxiesStub stub)

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

Parameter

Name	Description
stub	RegionTargetHttpProxiesStub

Returns

Type	Description
RegionTargetHttpProxiesClient

Constructors

RegionTargetHttpProxiesClient(RegionTargetHttpProxiesSettings settings)

protected RegionTargetHttpProxiesClient(RegionTargetHttpProxiesSettings settings)

Constructs an instance of RegionTargetHttpProxiesClient, 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	RegionTargetHttpProxiesSettings

RegionTargetHttpProxiesClient(RegionTargetHttpProxiesStub stub)

protected RegionTargetHttpProxiesClient(RegionTargetHttpProxiesStub stub)

Parameter

Name	Description
stub	RegionTargetHttpProxiesStub

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

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

Deletes the specified TargetHttpProxy resource.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   DeleteRegionTargetHttpProxyRequest request =
       DeleteRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   Operation response = regionTargetHttpProxiesClient.deleteAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteRegionTargetHttpProxyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String targetHttpProxy)

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

Deletes the specified TargetHttpProxy resource.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   Operation response =
       regionTargetHttpProxiesClient.deleteAsync(project, region, targetHttpProxy).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
targetHttpProxy	String Name of the TargetHttpProxy resource to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteRegionTargetHttpProxyRequest,Operation> deleteCallable()

Deletes the specified TargetHttpProxy resource.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   DeleteRegionTargetHttpProxyRequest request =
       DeleteRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   ApiFuture<Operation> future =
       regionTargetHttpProxiesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteRegionTargetHttpProxyRequest,Operation>

deleteOperationCallable()

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

Deletes the specified TargetHttpProxy resource.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   DeleteRegionTargetHttpProxyRequest request =
       DeleteRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteRegionTargetHttpProxyRequest,Operation,Operation>

get(GetRegionTargetHttpProxyRequest request)

public final TargetHttpProxy get(GetRegionTargetHttpProxyRequest request)

Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   GetRegionTargetHttpProxyRequest request =
       GetRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   TargetHttpProxy response = regionTargetHttpProxiesClient.get(request);
 }
 

Parameter

Name	Description
request	GetRegionTargetHttpProxyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TargetHttpProxy

get(String project, String region, String targetHttpProxy)

public final TargetHttpProxy get(String project, String region, String targetHttpProxy)

Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   TargetHttpProxy response =
       regionTargetHttpProxiesClient.get(project, region, targetHttpProxy);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
targetHttpProxy	String Name of the TargetHttpProxy resource to return.

Returns

Type	Description
TargetHttpProxy

getCallable()

public final UnaryCallable<GetRegionTargetHttpProxyRequest,TargetHttpProxy> getCallable()

Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   GetRegionTargetHttpProxyRequest request =
       GetRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetRegionTargetHttpProxyRequest,TargetHttpProxy>

getSettings()

public final RegionTargetHttpProxiesSettings getSettings()

Returns

Type	Description
RegionTargetHttpProxiesSettings

getStub()

public RegionTargetHttpProxiesStub getStub()

Returns

Type	Description
RegionTargetHttpProxiesStub

insertAsync(InsertRegionTargetHttpProxyRequest request)

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

Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   InsertRegionTargetHttpProxyRequest request =
       InsertRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   Operation response = regionTargetHttpProxiesClient.insertAsync(request).get();
 }
 

Parameter

Name	Description
request	InsertRegionTargetHttpProxyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, TargetHttpProxy targetHttpProxyResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, TargetHttpProxy targetHttpProxyResource)

Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   TargetHttpProxy targetHttpProxyResource = TargetHttpProxy.newBuilder().build();
   Operation response =
       regionTargetHttpProxiesClient.insertAsync(project, region, targetHttpProxyResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
targetHttpProxyResource	TargetHttpProxy The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRegionTargetHttpProxyRequest,Operation> insertCallable()

Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   InsertRegionTargetHttpProxyRequest request =
       InsertRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       regionTargetHttpProxiesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<InsertRegionTargetHttpProxyRequest,Operation>

insertOperationCallable()

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

Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   InsertRegionTargetHttpProxyRequest request =
       InsertRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<InsertRegionTargetHttpProxyRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListRegionTargetHttpProxiesRequest request)

public final RegionTargetHttpProxiesClient.ListPagedResponse list(ListRegionTargetHttpProxiesRequest request)

Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   ListRegionTargetHttpProxiesRequest request =
       ListRegionTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (TargetHttpProxy element : regionTargetHttpProxiesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListRegionTargetHttpProxiesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
RegionTargetHttpProxiesClient.ListPagedResponse

list(String project, String region)

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

Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (TargetHttpProxy element :
       regionTargetHttpProxiesClient.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
RegionTargetHttpProxiesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionTargetHttpProxiesRequest,TargetHttpProxyList> listCallable()

Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   ListRegionTargetHttpProxiesRequest request =
       ListRegionTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetHttpProxyList response = regionTargetHttpProxiesClient.listCallable().call(request);
     for (TargetHttpProxy element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRegionTargetHttpProxiesRequest,TargetHttpProxyList>

listPagedCallable()

public final UnaryCallable<ListRegionTargetHttpProxiesRequest,RegionTargetHttpProxiesClient.ListPagedResponse> listPagedCallable()

Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   ListRegionTargetHttpProxiesRequest request =
       ListRegionTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListRegionTargetHttpProxiesRequest,ListPagedResponse>

setUrlMapAsync(SetUrlMapRegionTargetHttpProxyRequest request)

public final OperationFuture<Operation,Operation> setUrlMapAsync(SetUrlMapRegionTargetHttpProxyRequest request)

Changes the URL map for TargetHttpProxy.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   SetUrlMapRegionTargetHttpProxyRequest request =
       SetUrlMapRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   Operation response = regionTargetHttpProxiesClient.setUrlMapAsync(request).get();
 }
 

Parameter

Name	Description
request	SetUrlMapRegionTargetHttpProxyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

setUrlMapAsync(String project, String region, String targetHttpProxy, UrlMapReference urlMapReferenceResource)

public final OperationFuture<Operation,Operation> setUrlMapAsync(String project, String region, String targetHttpProxy, UrlMapReference urlMapReferenceResource)

Changes the URL map for TargetHttpProxy.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   UrlMapReference urlMapReferenceResource = UrlMapReference.newBuilder().build();
   Operation response =
       regionTargetHttpProxiesClient
           .setUrlMapAsync(project, region, targetHttpProxy, urlMapReferenceResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
targetHttpProxy	String Name of the TargetHttpProxy to set a URL map for.
urlMapReferenceResource	UrlMapReference The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

setUrlMapCallable()

public final UnaryCallable<SetUrlMapRegionTargetHttpProxyRequest,Operation> setUrlMapCallable()

Changes the URL map for TargetHttpProxy.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   SetUrlMapRegionTargetHttpProxyRequest request =
       SetUrlMapRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       regionTargetHttpProxiesClient.setUrlMapCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<SetUrlMapRegionTargetHttpProxyRequest,Operation>

setUrlMapOperationCallable()

public final OperationCallable<SetUrlMapRegionTargetHttpProxyRequest,Operation,Operation> setUrlMapOperationCallable()

Changes the URL map for TargetHttpProxy.

Sample code:

 try (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   SetUrlMapRegionTargetHttpProxyRequest request =
       SetUrlMapRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<SetUrlMapRegionTargetHttpProxyRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()