Class TargetHttpProxiesClient (1.19.0)

Version 1.19.0

• 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 TargetHttpProxiesClient implements BackgroundResource

Service Description: The TargetHttpProxies 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   TargetHttpProxy response = targetHttpProxiesClient.get(project, targetHttpProxy);
 }
 

Note: close() needs to be called on the TargetHttpProxiesClient 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 TargetHttpProxiesSettings 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
 TargetHttpProxiesSettings targetHttpProxiesSettings =
     TargetHttpProxiesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetHttpProxiesClient targetHttpProxiesClient =
     TargetHttpProxiesClient.create(targetHttpProxiesSettings);
 

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
 TargetHttpProxiesSettings targetHttpProxiesSettings =
     TargetHttpProxiesSettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetHttpProxiesClient targetHttpProxiesClient =
     TargetHttpProxiesClient.create(targetHttpProxiesSettings);
 

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

Inheritance

java.lang.Object > TargetHttpProxiesClient

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 TargetHttpProxiesClient create()

Constructs an instance of TargetHttpProxiesClient with default settings.

Returns

Type	Description
TargetHttpProxiesClient

Exceptions

Type	Description
IOException

create(TargetHttpProxiesSettings settings)

public static final TargetHttpProxiesClient create(TargetHttpProxiesSettings settings)

Constructs an instance of TargetHttpProxiesClient, 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	TargetHttpProxiesSettings

Returns

Type	Description
TargetHttpProxiesClient

Exceptions

Type	Description
IOException

create(TargetHttpProxiesStub stub)

public static final TargetHttpProxiesClient create(TargetHttpProxiesStub stub)

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

Parameter

Name	Description
stub	TargetHttpProxiesStub

Returns

Type	Description
TargetHttpProxiesClient

Constructors

TargetHttpProxiesClient(TargetHttpProxiesSettings settings)

protected TargetHttpProxiesClient(TargetHttpProxiesSettings settings)

Constructs an instance of TargetHttpProxiesClient, 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	TargetHttpProxiesSettings

TargetHttpProxiesClient(TargetHttpProxiesStub stub)

protected TargetHttpProxiesClient(TargetHttpProxiesStub stub)

Parameter

Name	Description
stub	TargetHttpProxiesStub

Methods

aggregatedList(AggregatedListTargetHttpProxiesRequest request)

public final TargetHttpProxiesClient.AggregatedListPagedResponse aggregatedList(AggregatedListTargetHttpProxiesRequest request)

Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   AggregatedListTargetHttpProxiesRequest request =
       AggregatedListTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, TargetHttpProxiesScopedList> element :
       targetHttpProxiesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
TargetHttpProxiesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final TargetHttpProxiesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, TargetHttpProxiesScopedList> element :
       targetHttpProxiesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
project	String Name of the project scoping this request.

Returns

Type	Description
TargetHttpProxiesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListTargetHttpProxiesRequest,TargetHttpProxyAggregatedList> aggregatedListCallable()

Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   AggregatedListTargetHttpProxiesRequest request =
       AggregatedListTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetHttpProxyAggregatedList response =
         targetHttpProxiesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, TargetHttpProxiesScopedList> 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<AggregatedListTargetHttpProxiesRequest,TargetHttpProxyAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListTargetHttpProxiesRequest,TargetHttpProxiesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   AggregatedListTargetHttpProxiesRequest request =
       AggregatedListTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, TargetHttpProxiesScopedList>> future =
       targetHttpProxiesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, TargetHttpProxiesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<AggregatedListTargetHttpProxiesRequest,AggregatedListPagedResponse>

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

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

Deletes the specified TargetHttpProxy 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   DeleteTargetHttpProxyRequest request =
       DeleteTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   Operation response = targetHttpProxiesClient.deleteAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String targetHttpProxy)

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

Deletes the specified TargetHttpProxy 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   Operation response = targetHttpProxiesClient.deleteAsync(project, targetHttpProxy).get();
 }
 

Parameters

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteTargetHttpProxyRequest,Operation> deleteCallable()

Deletes the specified TargetHttpProxy 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   DeleteTargetHttpProxyRequest request =
       DeleteTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   ApiFuture<Operation> future = targetHttpProxiesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteTargetHttpProxyRequest,Operation>

deleteOperationCallable()

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

Deletes the specified TargetHttpProxy 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   DeleteTargetHttpProxyRequest request =
       DeleteTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   OperationFuture<Operation, Operation> future =
       targetHttpProxiesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteTargetHttpProxyRequest,Operation,Operation>

get(GetTargetHttpProxyRequest request)

public final TargetHttpProxy get(GetTargetHttpProxyRequest request)

Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   GetTargetHttpProxyRequest request =
       GetTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   TargetHttpProxy response = targetHttpProxiesClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
TargetHttpProxy

get(String project, String targetHttpProxy)

public final TargetHttpProxy get(String project, String targetHttpProxy)

Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   TargetHttpProxy response = targetHttpProxiesClient.get(project, targetHttpProxy);
 }
 

Parameters

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

Returns

Type	Description
TargetHttpProxy

getCallable()

public final UnaryCallable<GetTargetHttpProxyRequest,TargetHttpProxy> getCallable()

Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   GetTargetHttpProxyRequest request =
       GetTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   ApiFuture<TargetHttpProxy> future = targetHttpProxiesClient.getCallable().futureCall(request);
   // Do something.
   TargetHttpProxy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetTargetHttpProxyRequest,TargetHttpProxy>

getSettings()

public final TargetHttpProxiesSettings getSettings()

Returns

Type	Description
TargetHttpProxiesSettings

getStub()

public TargetHttpProxiesStub getStub()

Returns

Type	Description
TargetHttpProxiesStub

insertAsync(InsertTargetHttpProxyRequest request)

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

Creates a TargetHttpProxy resource in the specified project 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   InsertTargetHttpProxyRequest request =
       InsertTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   Operation response = targetHttpProxiesClient.insertAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, TargetHttpProxy targetHttpProxyResource)

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

Creates a TargetHttpProxy resource in the specified project 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   TargetHttpProxy targetHttpProxyResource = TargetHttpProxy.newBuilder().build();
   Operation response =
       targetHttpProxiesClient.insertAsync(project, targetHttpProxyResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
targetHttpProxyResource	TargetHttpProxy The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertTargetHttpProxyRequest,Operation> insertCallable()

Creates a TargetHttpProxy resource in the specified project 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   InsertTargetHttpProxyRequest request =
       InsertTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   ApiFuture<Operation> future = targetHttpProxiesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<InsertTargetHttpProxyRequest,Operation>

insertOperationCallable()

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

Creates a TargetHttpProxy resource in the specified project 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   InsertTargetHttpProxyRequest request =
       InsertTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       targetHttpProxiesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<InsertTargetHttpProxyRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListTargetHttpProxiesRequest request)

public final TargetHttpProxiesClient.ListPagedResponse list(ListTargetHttpProxiesRequest request)

Retrieves the list of TargetHttpProxy resources available to the specified 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   ListTargetHttpProxiesRequest request =
       ListTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (TargetHttpProxy element : targetHttpProxiesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
TargetHttpProxiesClient.ListPagedResponse

list(String project)

public final TargetHttpProxiesClient.ListPagedResponse list(String project)

Retrieves the list of TargetHttpProxy resources available to the specified 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   for (TargetHttpProxy element : targetHttpProxiesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
TargetHttpProxiesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListTargetHttpProxiesRequest,TargetHttpProxyList> listCallable()

Retrieves the list of TargetHttpProxy resources available to the specified 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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   ListTargetHttpProxiesRequest request =
       ListTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetHttpProxyList response = targetHttpProxiesClient.listCallable().call(request);
     for (TargetHttpProxy 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<ListTargetHttpProxiesRequest,TargetHttpProxyList>

listPagedCallable()

public final UnaryCallable<ListTargetHttpProxiesRequest,TargetHttpProxiesClient.ListPagedResponse> listPagedCallable()

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

Returns

Type	Description
UnaryCallable<ListTargetHttpProxiesRequest,ListPagedResponse>

patchAsync(PatchTargetHttpProxyRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchTargetHttpProxyRequest request)

Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   PatchTargetHttpProxyRequest request =
       PatchTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   Operation response = targetHttpProxiesClient.patchAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String targetHttpProxy, TargetHttpProxy targetHttpProxyResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String targetHttpProxy, TargetHttpProxy targetHttpProxyResource)

Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   TargetHttpProxy targetHttpProxyResource = TargetHttpProxy.newBuilder().build();
   Operation response =
       targetHttpProxiesClient
           .patchAsync(project, targetHttpProxy, targetHttpProxyResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
targetHttpProxy	String Name of the TargetHttpProxy resource to patch.
targetHttpProxyResource	TargetHttpProxy The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchTargetHttpProxyRequest,Operation> patchCallable()

Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   PatchTargetHttpProxyRequest request =
       PatchTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   ApiFuture<Operation> future = targetHttpProxiesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<PatchTargetHttpProxyRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchTargetHttpProxyRequest,Operation,Operation> patchOperationCallable()

Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   PatchTargetHttpProxyRequest request =
       PatchTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       targetHttpProxiesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<PatchTargetHttpProxyRequest,Operation,Operation>

setUrlMapAsync(SetUrlMapTargetHttpProxyRequest request)

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

Changes the URL map for TargetHttpProxy.

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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   SetUrlMapTargetHttpProxyRequest request =
       SetUrlMapTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   Operation response = targetHttpProxiesClient.setUrlMapAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

setUrlMapAsync(String project, String targetHttpProxy, UrlMapReference urlMapReferenceResource)

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

Changes the URL map for TargetHttpProxy.

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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   UrlMapReference urlMapReferenceResource = UrlMapReference.newBuilder().build();
   Operation response =
       targetHttpProxiesClient
           .setUrlMapAsync(project, targetHttpProxy, urlMapReferenceResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for 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<SetUrlMapTargetHttpProxyRequest,Operation> setUrlMapCallable()

Changes the URL map for TargetHttpProxy.

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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   SetUrlMapTargetHttpProxyRequest request =
       SetUrlMapTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   ApiFuture<Operation> future = targetHttpProxiesClient.setUrlMapCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<SetUrlMapTargetHttpProxyRequest,Operation>

setUrlMapOperationCallable()

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

Changes the URL map for TargetHttpProxy.

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 (TargetHttpProxiesClient targetHttpProxiesClient = TargetHttpProxiesClient.create()) {
   SetUrlMapTargetHttpProxyRequest request =
       SetUrlMapTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       targetHttpProxiesClient.setUrlMapOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<SetUrlMapTargetHttpProxyRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()