Class RegionTargetHttpProxiesClient (1.16.0)

Service Description: The RegionTargetHttpProxies API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

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

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

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

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

See the individual methods for example code.

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

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

To customize credentials:

 // 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
 RegionTargetHttpProxiesSettings regionTargetHttpProxiesSettings =
     RegionTargetHttpProxiesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create(regionTargetHttpProxiesSettings);
 

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
 RegionTargetHttpProxiesSettings regionTargetHttpProxiesSettings =
     RegionTargetHttpProxiesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create(regionTargetHttpProxiesSettings);
 

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

Constructs an instance of RegionTargetHttpProxiesClient with default settings.

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

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

Constructs an instance of RegionTargetHttpProxiesClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   DeleteRegionTargetHttpProxyRequest request =
       DeleteRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   Operation response = regionTargetHttpProxiesClient.deleteAsync(request).get();
 }
 

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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String targetHttpProxy = "targetHttpProxy-1944074187";
   Operation response =
       regionTargetHttpProxiesClient.deleteAsync(project, region, targetHttpProxy).get();
 }
 

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

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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   DeleteRegionTargetHttpProxyRequest request =
       DeleteRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetHttpProxiesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns the specified TargetHttpProxy resource in the specified region. 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   GetRegionTargetHttpProxyRequest request =
       GetRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   TargetHttpProxy response = regionTargetHttpProxiesClient.get(request);
 }
 

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

Sample code:

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

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

Sample code:

 // 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   GetRegionTargetHttpProxyRequest request =
       GetRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setTargetHttpProxy("targetHttpProxy-1944074187")
           .build();
   ApiFuture<TargetHttpProxy> future =
       regionTargetHttpProxiesClient.getCallable().futureCall(request);
   // Do something.
   TargetHttpProxy response = future.get();
 }
 

Creates a TargetHttpProxy 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   InsertRegionTargetHttpProxyRequest request =
       InsertRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   Operation response = regionTargetHttpProxiesClient.insertAsync(request).get();
 }
 

Creates a TargetHttpProxy 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   TargetHttpProxy targetHttpProxyResource = TargetHttpProxy.newBuilder().build();
   Operation response =
       regionTargetHttpProxiesClient.insertAsync(project, region, targetHttpProxyResource).get();
 }
 

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

Creates a TargetHttpProxy 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   InsertRegionTargetHttpProxyRequest request =
       InsertRegionTargetHttpProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetHttpProxyResource(TargetHttpProxy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       regionTargetHttpProxiesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Retrieves the list of TargetHttpProxy 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   ListRegionTargetHttpProxiesRequest request =
       ListRegionTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (TargetHttpProxy element : regionTargetHttpProxiesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Retrieves the list of TargetHttpProxy 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (TargetHttpProxy element :
       regionTargetHttpProxiesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Retrieves the list of TargetHttpProxy 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 (RegionTargetHttpProxiesClient regionTargetHttpProxiesClient =
     RegionTargetHttpProxiesClient.create()) {
   ListRegionTargetHttpProxiesRequest request =
       ListRegionTargetHttpProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetHttpProxyList response = regionTargetHttpProxiesClient.listCallable().call(request);
     for (TargetHttpProxy element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

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

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

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

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

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