Class RegionTargetHttpsProxiesClient (1.51.0)

GitHub RepositoryProduct Reference

Service Description: The RegionTargetHttpsProxies 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpsProxy = "targetHttpsProxy833943732";
   TargetHttpsProxy response =
       regionTargetHttpsProxiesClient.get(project, region, targetHttpsProxy);
 }
 

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

Methods
MethodDescriptionMethod Variants

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(DeleteRegionTargetHttpsProxyRequest 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 region, 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 in the specified region.

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

  • get(GetRegionTargetHttpsProxyRequest 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 region, 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 and region 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(InsertRegionTargetHttpsProxyRequest 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, String region, 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 in the specified region.

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

  • list(ListRegionTargetHttpsProxiesRequest 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, String region)

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 regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON 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(PatchRegionTargetHttpsProxyRequest 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 region, 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()

SetSslCertificates

Replaces SslCertificates for TargetHttpsProxy.

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

  • setSslCertificatesAsync(SetSslCertificatesRegionTargetHttpsProxyRequest 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 region, String targetHttpsProxy, RegionTargetHttpsProxiesSetSslCertificatesRequest regionTargetHttpsProxiesSetSslCertificatesRequestResource)

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

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(SetUrlMapRegionTargetHttpsProxyRequest 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 region, 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 RegionTargetHttpsProxiesSettings 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
 RegionTargetHttpsProxiesSettings regionTargetHttpsProxiesSettings =
     RegionTargetHttpsProxiesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create(regionTargetHttpsProxiesSettings);
 

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
 RegionTargetHttpsProxiesSettings regionTargetHttpsProxiesSettings =
     RegionTargetHttpsProxiesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create(regionTargetHttpsProxiesSettings);
 

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

Inheritance

java.lang.Object > RegionTargetHttpsProxiesClient

Static Methods

create()

public static final RegionTargetHttpsProxiesClient create()

Constructs an instance of RegionTargetHttpsProxiesClient with default settings.

Returns
TypeDescription
RegionTargetHttpsProxiesClient
Exceptions
TypeDescription
IOException

create(RegionTargetHttpsProxiesSettings settings)

public static final RegionTargetHttpsProxiesClient create(RegionTargetHttpsProxiesSettings settings)

Constructs an instance of RegionTargetHttpsProxiesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsRegionTargetHttpsProxiesSettings
Returns
TypeDescription
RegionTargetHttpsProxiesClient
Exceptions
TypeDescription
IOException

create(RegionTargetHttpsProxiesStub stub)

public static final RegionTargetHttpsProxiesClient create(RegionTargetHttpsProxiesStub stub)

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

Parameter
NameDescription
stubRegionTargetHttpsProxiesStub
Returns
TypeDescription
RegionTargetHttpsProxiesClient

Constructors

RegionTargetHttpsProxiesClient(RegionTargetHttpsProxiesSettings settings)

protected RegionTargetHttpsProxiesClient(RegionTargetHttpsProxiesSettings settings)

Constructs an instance of RegionTargetHttpsProxiesClient, 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
NameDescription
settingsRegionTargetHttpsProxiesSettings

RegionTargetHttpsProxiesClient(RegionTargetHttpsProxiesStub stub)

protected RegionTargetHttpsProxiesClient(RegionTargetHttpsProxiesStub stub)
Parameter
NameDescription
stubRegionTargetHttpsProxiesStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

deleteAsync(DeleteRegionTargetHttpsProxyRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionTargetHttpsProxyRequest 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   DeleteRegionTargetHttpsProxyRequest request =
       DeleteRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   Operation response = regionTargetHttpsProxiesClient.deleteAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteRegionTargetHttpsProxyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String targetHttpsProxy)

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

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpsProxy = "targetHttpsProxy833943732";
   Operation response =
       regionTargetHttpsProxiesClient.deleteAsync(project, region, targetHttpsProxy).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

targetHttpsProxyString

Name of the TargetHttpsProxy resource to delete.

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteRegionTargetHttpsProxyRequest,Operation> deleteCallable()

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   DeleteRegionTargetHttpsProxyRequest request =
       DeleteRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   ApiFuture<Operation> future =
       regionTargetHttpsProxiesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteRegionTargetHttpsProxyRequest,Operation>

deleteOperationCallable()

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

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   DeleteRegionTargetHttpsProxyRequest request =
       DeleteRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetHttpsProxiesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteRegionTargetHttpsProxyRequest,Operation,Operation>

get(GetRegionTargetHttpsProxyRequest request)

public final TargetHttpsProxy get(GetRegionTargetHttpsProxyRequest request)

Returns the specified TargetHttpsProxy resource in the specified 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   GetRegionTargetHttpsProxyRequest request =
       GetRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   TargetHttpsProxy response = regionTargetHttpsProxiesClient.get(request);
 }
 
Parameter
NameDescription
requestGetRegionTargetHttpsProxyRequest

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

Returns
TypeDescription
TargetHttpsProxy

get(String project, String region, String targetHttpsProxy)

public final TargetHttpsProxy get(String project, String region, String targetHttpsProxy)

Returns the specified TargetHttpsProxy resource in the specified 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpsProxy = "targetHttpsProxy833943732";
   TargetHttpsProxy response =
       regionTargetHttpsProxiesClient.get(project, region, targetHttpsProxy);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

targetHttpsProxyString

Name of the TargetHttpsProxy resource to return.

Returns
TypeDescription
TargetHttpsProxy

getCallable()

public final UnaryCallable<GetRegionTargetHttpsProxyRequest,TargetHttpsProxy> getCallable()

Returns the specified TargetHttpsProxy resource in the specified 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   GetRegionTargetHttpsProxyRequest request =
       GetRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   ApiFuture<TargetHttpsProxy> future =
       regionTargetHttpsProxiesClient.getCallable().futureCall(request);
   // Do something.
   TargetHttpsProxy response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetRegionTargetHttpsProxyRequest,TargetHttpsProxy>

getSettings()

public final RegionTargetHttpsProxiesSettings getSettings()
Returns
TypeDescription
RegionTargetHttpsProxiesSettings

getStub()

public RegionTargetHttpsProxiesStub getStub()
Returns
TypeDescription
RegionTargetHttpsProxiesStub

insertAsync(InsertRegionTargetHttpsProxyRequest request)

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

Creates a TargetHttpsProxy 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   InsertRegionTargetHttpsProxyRequest request =
       InsertRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxyResource(TargetHttpsProxy.newBuilder().build())
           .build();
   Operation response = regionTargetHttpsProxiesClient.insertAsync(request).get();
 }
 
Parameter
NameDescription
requestInsertRegionTargetHttpsProxyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertAsync(String project, String region, TargetHttpsProxy targetHttpsProxyResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, TargetHttpsProxy targetHttpsProxyResource)

Creates a TargetHttpsProxy 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   Operation response =
       regionTargetHttpsProxiesClient
           .insertAsync(project, region, targetHttpsProxyResource)
           .get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

targetHttpsProxyResourceTargetHttpsProxy

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRegionTargetHttpsProxyRequest,Operation> insertCallable()

Creates a TargetHttpsProxy 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   InsertRegionTargetHttpsProxyRequest request =
       InsertRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxyResource(TargetHttpsProxy.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       regionTargetHttpsProxiesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<InsertRegionTargetHttpsProxyRequest,Operation>

insertOperationCallable()

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

Creates a TargetHttpsProxy 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   InsertRegionTargetHttpsProxyRequest request =
       InsertRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxyResource(TargetHttpsProxy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetHttpsProxiesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<InsertRegionTargetHttpsProxyRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

list(ListRegionTargetHttpsProxiesRequest request)

public final RegionTargetHttpsProxiesClient.ListPagedResponse list(ListRegionTargetHttpsProxiesRequest request)

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

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

Returns
TypeDescription
RegionTargetHttpsProxiesClient.ListPagedResponse

list(String project, String region)

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

Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (TargetHttpsProxy element :
       regionTargetHttpsProxiesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

Returns
TypeDescription
RegionTargetHttpsProxiesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionTargetHttpsProxiesRequest,TargetHttpsProxyList> listCallable()

Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   ListRegionTargetHttpsProxiesRequest request =
       ListRegionTargetHttpsProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetHttpsProxyList response = regionTargetHttpsProxiesClient.listCallable().call(request);
     for (TargetHttpsProxy element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListRegionTargetHttpsProxiesRequest,TargetHttpsProxyList>

listPagedCallable()

public final UnaryCallable<ListRegionTargetHttpsProxiesRequest,RegionTargetHttpsProxiesClient.ListPagedResponse> listPagedCallable()

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

patchAsync(PatchRegionTargetHttpsProxyRequest request)

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

Patches the specified regional TargetHttpsProxy 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   PatchRegionTargetHttpsProxyRequest request =
       PatchRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .setTargetHttpsProxyResource(TargetHttpsProxy.newBuilder().build())
           .build();
   Operation response = regionTargetHttpsProxiesClient.patchAsync(request).get();
 }
 
Parameter
NameDescription
requestPatchRegionTargetHttpsProxyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

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

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String targetHttpsProxy, TargetHttpsProxy targetHttpsProxyResource)

Patches the specified regional TargetHttpsProxy 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpsProxy = "targetHttpsProxy833943732";
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   Operation response =
       regionTargetHttpsProxiesClient
           .patchAsync(project, region, targetHttpsProxy, targetHttpsProxyResource)
           .get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

targetHttpsProxyString

Name of the TargetHttpsProxy resource to patch.

targetHttpsProxyResourceTargetHttpsProxy

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchRegionTargetHttpsProxyRequest,Operation> patchCallable()

Patches the specified regional TargetHttpsProxy 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   PatchRegionTargetHttpsProxyRequest request =
       PatchRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .setTargetHttpsProxyResource(TargetHttpsProxy.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       regionTargetHttpsProxiesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<PatchRegionTargetHttpsProxyRequest,Operation>

patchOperationCallable()

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

Patches the specified regional TargetHttpsProxy 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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   PatchRegionTargetHttpsProxyRequest request =
       PatchRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .setTargetHttpsProxyResource(TargetHttpsProxy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetHttpsProxiesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<PatchRegionTargetHttpsProxyRequest,Operation,Operation>

setSslCertificatesAsync(SetSslCertificatesRegionTargetHttpsProxyRequest request)

public final OperationFuture<Operation,Operation> setSslCertificatesAsync(SetSslCertificatesRegionTargetHttpsProxyRequest request)

Replaces SslCertificates for TargetHttpsProxy.

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   SetSslCertificatesRegionTargetHttpsProxyRequest request =
       SetSslCertificatesRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionTargetHttpsProxiesSetSslCertificatesRequestResource(
               RegionTargetHttpsProxiesSetSslCertificatesRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   Operation response = regionTargetHttpsProxiesClient.setSslCertificatesAsync(request).get();
 }
 
Parameter
NameDescription
requestSetSslCertificatesRegionTargetHttpsProxyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

setSslCertificatesAsync(String project, String region, String targetHttpsProxy, RegionTargetHttpsProxiesSetSslCertificatesRequest regionTargetHttpsProxiesSetSslCertificatesRequestResource)

public final OperationFuture<Operation,Operation> setSslCertificatesAsync(String project, String region, String targetHttpsProxy, RegionTargetHttpsProxiesSetSslCertificatesRequest regionTargetHttpsProxiesSetSslCertificatesRequestResource)

Replaces SslCertificates for TargetHttpsProxy.

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpsProxy = "targetHttpsProxy833943732";
   RegionTargetHttpsProxiesSetSslCertificatesRequest
       regionTargetHttpsProxiesSetSslCertificatesRequestResource =
           RegionTargetHttpsProxiesSetSslCertificatesRequest.newBuilder().build();
   Operation response =
       regionTargetHttpsProxiesClient
           .setSslCertificatesAsync(
               project,
               region,
               targetHttpsProxy,
               regionTargetHttpsProxiesSetSslCertificatesRequestResource)
           .get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

targetHttpsProxyString

Name of the TargetHttpsProxy resource to set an SslCertificates resource for.

regionTargetHttpsProxiesSetSslCertificatesRequestResourceRegionTargetHttpsProxiesSetSslCertificatesRequest

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

setSslCertificatesCallable()

public final UnaryCallable<SetSslCertificatesRegionTargetHttpsProxyRequest,Operation> setSslCertificatesCallable()

Replaces SslCertificates for TargetHttpsProxy.

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   SetSslCertificatesRegionTargetHttpsProxyRequest request =
       SetSslCertificatesRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionTargetHttpsProxiesSetSslCertificatesRequestResource(
               RegionTargetHttpsProxiesSetSslCertificatesRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   ApiFuture<Operation> future =
       regionTargetHttpsProxiesClient.setSslCertificatesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<SetSslCertificatesRegionTargetHttpsProxyRequest,Operation>

setSslCertificatesOperationCallable()

public final OperationCallable<SetSslCertificatesRegionTargetHttpsProxyRequest,Operation,Operation> setSslCertificatesOperationCallable()

Replaces SslCertificates for TargetHttpsProxy.

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   SetSslCertificatesRegionTargetHttpsProxyRequest request =
       SetSslCertificatesRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionTargetHttpsProxiesSetSslCertificatesRequestResource(
               RegionTargetHttpsProxiesSetSslCertificatesRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetHttpsProxiesClient.setSslCertificatesOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<SetSslCertificatesRegionTargetHttpsProxyRequest,Operation,Operation>

setUrlMapAsync(SetUrlMapRegionTargetHttpsProxyRequest request)

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

Changes the URL map for TargetHttpsProxy.

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   SetUrlMapRegionTargetHttpsProxyRequest request =
       SetUrlMapRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   Operation response = regionTargetHttpsProxiesClient.setUrlMapAsync(request).get();
 }
 
Parameter
NameDescription
requestSetUrlMapRegionTargetHttpsProxyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

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

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

Changes the URL map for TargetHttpsProxy.

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpsProxy = "targetHttpsProxy833943732";
   UrlMapReference urlMapReferenceResource = UrlMapReference.newBuilder().build();
   Operation response =
       regionTargetHttpsProxiesClient
           .setUrlMapAsync(project, region, targetHttpsProxy, urlMapReferenceResource)
           .get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

targetHttpsProxyString

Name of the TargetHttpsProxy to set a URL map for.

urlMapReferenceResourceUrlMapReference

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

setUrlMapCallable()

public final UnaryCallable<SetUrlMapRegionTargetHttpsProxyRequest,Operation> setUrlMapCallable()

Changes the URL map for TargetHttpsProxy.

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   SetUrlMapRegionTargetHttpsProxyRequest request =
       SetUrlMapRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       regionTargetHttpsProxiesClient.setUrlMapCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<SetUrlMapRegionTargetHttpsProxyRequest,Operation>

setUrlMapOperationCallable()

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

Changes the URL map for TargetHttpsProxy.

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 (RegionTargetHttpsProxiesClient regionTargetHttpsProxiesClient =
     RegionTargetHttpsProxiesClient.create()) {
   SetUrlMapRegionTargetHttpsProxyRequest request =
       SetUrlMapRegionTargetHttpsProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpsProxy("targetHttpsProxy833943732")
           .setUrlMapReferenceResource(UrlMapReference.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetHttpsProxiesClient.setUrlMapOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<SetUrlMapRegionTargetHttpsProxyRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()