Class TargetHttpsProxiesClient (1.91.0)

GitHub RepositoryProduct Reference

Service Description: The TargetHttpsProxies 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 (TargetHttpsProxiesClient targetHttpsProxiesClient = TargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String targetHttpsProxy = "targetHttpsProxy833943732";
   TargetHttpsProxy response = targetHttpsProxiesClient.get(project, targetHttpsProxy);
 }

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

Methods
Method Description Method Variants

AggregatedList

Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • aggregatedList(AggregatedListTargetHttpsProxiesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • aggregatedList(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Delete

Deletes the specified TargetHttpsProxy resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteTargetHttpsProxyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String targetHttpsProxy)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteOperationCallable()

  • deleteCallable()

Get

Returns the specified TargetHttpsProxy resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetTargetHttpsProxyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String targetHttpsProxy)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

Insert

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • insertAsync(InsertTargetHttpsProxyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, TargetHttpsProxy targetHttpsProxyResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertOperationCallable()

  • insertCallable()

List

Retrieves the list of TargetHttpsProxy resources available to the specified project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListTargetHttpsProxiesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

Patch

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • patchAsync(PatchTargetHttpsProxyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • patchAsync(String project, String targetHttpsProxy, TargetHttpsProxy targetHttpsProxyResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • patchOperationCallable()

  • patchCallable()

SetCertificateMap

Changes the Certificate Map for TargetHttpsProxy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setCertificateMapAsync(SetCertificateMapTargetHttpsProxyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • setCertificateMapAsync(String project, String targetHttpsProxy, TargetHttpsProxiesSetCertificateMapRequest targetHttpsProxiesSetCertificateMapRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setCertificateMapOperationCallable()

  • setCertificateMapCallable()

SetQuicOverride

Sets the QUIC override policy for TargetHttpsProxy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setQuicOverrideAsync(SetQuicOverrideTargetHttpsProxyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • setQuicOverrideAsync(String project, String targetHttpsProxy, TargetHttpsProxiesSetQuicOverrideRequest targetHttpsProxiesSetQuicOverrideRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setQuicOverrideOperationCallable()

  • setQuicOverrideCallable()

SetSslCertificates

Replaces SslCertificates for TargetHttpsProxy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setSslCertificatesAsync(SetSslCertificatesTargetHttpsProxyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • setSslCertificatesAsync(String project, String targetHttpsProxy, TargetHttpsProxiesSetSslCertificatesRequest targetHttpsProxiesSetSslCertificatesRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setSslCertificatesOperationCallable()

  • setSslCertificatesCallable()

SetSslPolicy

Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setSslPolicyAsync(SetSslPolicyTargetHttpsProxyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • setSslPolicyAsync(String project, String targetHttpsProxy, SslPolicyReference sslPolicyReferenceResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setSslPolicyOperationCallable()

  • setSslPolicyCallable()

SetUrlMap

Changes the URL map for TargetHttpsProxy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setUrlMapAsync(SetUrlMapTargetHttpsProxyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • setUrlMapAsync(String project, String targetHttpsProxy, UrlMapReference urlMapReferenceResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setUrlMapOperationCallable()

  • setUrlMapCallable()

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 TargetHttpsProxiesSettings 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
 TargetHttpsProxiesSettings targetHttpsProxiesSettings =
     TargetHttpsProxiesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetHttpsProxiesClient targetHttpsProxiesClient =
     TargetHttpsProxiesClient.create(targetHttpsProxiesSettings);

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
 TargetHttpsProxiesSettings targetHttpsProxiesSettings =
     TargetHttpsProxiesSettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetHttpsProxiesClient targetHttpsProxiesClient =
     TargetHttpsProxiesClient.create(targetHttpsProxiesSettings);

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

Inheritance

java.lang.Object > TargetHttpsProxiesClient

Static Methods

create()

public static final TargetHttpsProxiesClient create()

Constructs an instance of TargetHttpsProxiesClient with default settings.

Returns
Type Description
TargetHttpsProxiesClient
Exceptions
Type Description
IOException

create(TargetHttpsProxiesSettings settings)

public static final TargetHttpsProxiesClient create(TargetHttpsProxiesSettings settings)

Constructs an instance of TargetHttpsProxiesClient, 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 TargetHttpsProxiesSettings
Returns
Type Description
TargetHttpsProxiesClient
Exceptions
Type Description
IOException

create(TargetHttpsProxiesStub stub)

public static final TargetHttpsProxiesClient create(TargetHttpsProxiesStub stub)

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

Parameter
Name Description
stub TargetHttpsProxiesStub
Returns
Type Description
TargetHttpsProxiesClient

Constructors

TargetHttpsProxiesClient(TargetHttpsProxiesSettings settings)

protected TargetHttpsProxiesClient(TargetHttpsProxiesSettings settings)

Constructs an instance of TargetHttpsProxiesClient, 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 TargetHttpsProxiesSettings

TargetHttpsProxiesClient(TargetHttpsProxiesStub stub)

protected TargetHttpsProxiesClient(TargetHttpsProxiesStub stub)
Parameter
Name Description
stub TargetHttpsProxiesStub

Methods

aggregatedList(AggregatedListTargetHttpsProxiesRequest request)

public final TargetHttpsProxiesClient.AggregatedListPagedResponse aggregatedList(AggregatedListTargetHttpsProxiesRequest request)

Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (TargetHttpsProxiesClient targetHttpsProxiesClient = TargetHttpsProxiesClient.create()) {
   AggregatedListTargetHttpsProxiesRequest request =
       AggregatedListTargetHttpsProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, TargetHttpsProxiesScopedList> element :
       targetHttpsProxiesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListTargetHttpsProxiesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TargetHttpsProxiesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final TargetHttpsProxiesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (TargetHttpsProxiesClient targetHttpsProxiesClient = TargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, TargetHttpsProxiesScopedList> element :
       targetHttpsProxiesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Name of the project scoping this request.
Returns
Type Description
TargetHttpsProxiesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListTargetHttpsProxiesRequest,TargetHttpsProxyAggregatedList> aggregatedListCallable()

Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (TargetHttpsProxiesClient targetHttpsProxiesClient = TargetHttpsProxiesClient.create()) {
   AggregatedListTargetHttpsProxiesRequest request =
       AggregatedListTargetHttpsProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     TargetHttpsProxyAggregatedList response =
         targetHttpsProxiesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, TargetHttpsProxiesScopedList> 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<AggregatedListTargetHttpsProxiesRequest,TargetHttpsProxyAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListTargetHttpsProxiesRequest,TargetHttpsProxiesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (TargetHttpsProxiesClient targetHttpsProxiesClient = TargetHttpsProxiesClient.create()) {
   AggregatedListTargetHttpsProxiesRequest request =
       AggregatedListTargetHttpsProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, TargetHttpsProxiesScopedList>> future =
       targetHttpsProxiesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, TargetHttpsProxiesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListTargetHttpsProxiesRequest,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(DeleteTargetHttpsProxyRequest request)

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

Deletes the specified TargetHttpsProxy 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 (TargetHttpsProxiesClient targetHttpsProxiesClient = TargetHttpsProxiesClient.create()) {
   DeleteTargetHttpsProxyRequest request =
       DeleteTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   Operation response = targetHttpsProxiesClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteTargetHttpsProxyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>