RegionTargetHttpsProxyClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.RegionTargetHttpsProxyClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class RegionTargetHttpsProxyClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Creates and runs virtual machines on Google Cloud Platform.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   ProjectRegionTargetHttpsProxyName targetHttpsProxy = ProjectRegionTargetHttpsProxyName.of("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   Operation response = regionTargetHttpsProxyClient.deleteRegionTargetHttpsProxy(targetHttpsProxy);
 }
 
 
```
Note: close() needs to be called on the regionTargetHttpsProxyClient 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 RegionTargetHttpsProxySettings to create(). For example:
To customize credentials:
```
 
 RegionTargetHttpsProxySettings regionTargetHttpsProxySettings =
     RegionTargetHttpsProxySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionTargetHttpsProxyClient regionTargetHttpsProxyClient =
     RegionTargetHttpsProxyClient.create(regionTargetHttpsProxySettings);
 
 
```
To customize the endpoint:
```
 
 RegionTargetHttpsProxySettings regionTargetHttpsProxySettings =
     RegionTargetHttpsProxySettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionTargetHttpsProxyClient regionTargetHttpsProxyClient =
     RegionTargetHttpsProxyClient.create(regionTargetHttpsProxySettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RegionTargetHttpsProxyClient.ListRegionTargetHttpsProxiesFixedSizeCollection`
`static class`	`RegionTargetHttpsProxyClient.ListRegionTargetHttpsProxiesPage`
`static class`	`RegionTargetHttpsProxyClient.ListRegionTargetHttpsProxiesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RegionTargetHttpsProxyClient(RegionTargetHttpsProxySettings settings)` Constructs an instance of RegionTargetHttpsProxyClient, using the given settings.
`protected`	`RegionTargetHttpsProxyClient(RegionTargetHttpsProxyStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static RegionTargetHttpsProxyClient`	`create()` Constructs an instance of RegionTargetHttpsProxyClient with default settings.
`static RegionTargetHttpsProxyClient`	`create(RegionTargetHttpsProxySettings settings)` Constructs an instance of RegionTargetHttpsProxyClient, using the given settings.
`static RegionTargetHttpsProxyClient`	`create(RegionTargetHttpsProxyStub stub)` Constructs an instance of RegionTargetHttpsProxyClient, using the given stub for making calls.
`Operation`	`deleteRegionTargetHttpsProxy(DeleteRegionTargetHttpsProxyHttpRequest request)` Deletes the specified TargetHttpsProxy resource.
`Operation`	`deleteRegionTargetHttpsProxy(ProjectRegionTargetHttpsProxyName targetHttpsProxy)` Deletes the specified TargetHttpsProxy resource.
`Operation`	`deleteRegionTargetHttpsProxy(String targetHttpsProxy)` Deletes the specified TargetHttpsProxy resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteRegionTargetHttpsProxyHttpRequest,Operation>`	`deleteRegionTargetHttpsProxyCallable()` Deletes the specified TargetHttpsProxy resource.
`TargetHttpsProxy`	`getRegionTargetHttpsProxy(GetRegionTargetHttpsProxyHttpRequest request)` Returns the specified TargetHttpsProxy resource in the specified region.
`TargetHttpsProxy`	`getRegionTargetHttpsProxy(ProjectRegionTargetHttpsProxyName targetHttpsProxy)` Returns the specified TargetHttpsProxy resource in the specified region.
`TargetHttpsProxy`	`getRegionTargetHttpsProxy(String targetHttpsProxy)` Returns the specified TargetHttpsProxy resource in the specified region.
`com.google.api.gax.rpc.UnaryCallable<GetRegionTargetHttpsProxyHttpRequest,TargetHttpsProxy>`	`getRegionTargetHttpsProxyCallable()` Returns the specified TargetHttpsProxy resource in the specified region.
`RegionTargetHttpsProxySettings`	`getSettings()`
`RegionTargetHttpsProxyStub`	`getStub()`
`Operation`	`insertRegionTargetHttpsProxy(InsertRegionTargetHttpsProxyHttpRequest request)` Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
`Operation`	`insertRegionTargetHttpsProxy(ProjectRegionName region, TargetHttpsProxy targetHttpsProxyResource)` Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
`Operation`	`insertRegionTargetHttpsProxy(String region, TargetHttpsProxy targetHttpsProxyResource)` Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertRegionTargetHttpsProxyHttpRequest,Operation>`	`insertRegionTargetHttpsProxyCallable()` Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`RegionTargetHttpsProxyClient.ListRegionTargetHttpsProxiesPagedResponse`	`listRegionTargetHttpsProxies(ListRegionTargetHttpsProxiesHttpRequest request)` Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
`RegionTargetHttpsProxyClient.ListRegionTargetHttpsProxiesPagedResponse`	`listRegionTargetHttpsProxies(ProjectRegionName region)` Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
`RegionTargetHttpsProxyClient.ListRegionTargetHttpsProxiesPagedResponse`	`listRegionTargetHttpsProxies(String region)` Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListRegionTargetHttpsProxiesHttpRequest,TargetHttpsProxyList>`	`listRegionTargetHttpsProxiesCallable()` Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListRegionTargetHttpsProxiesHttpRequest,RegionTargetHttpsProxyClient.ListRegionTargetHttpsProxiesPagedResponse>`	`listRegionTargetHttpsProxiesPagedCallable()` Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
`Operation`	`setSslCertificatesRegionTargetHttpsProxy(ProjectRegionTargetHttpsProxyName targetHttpsProxy, RegionTargetHttpsProxiesSetSslCertificatesRequest regionTargetHttpsProxiesSetSslCertificatesRequestResource)` Replaces SslCertificates for TargetHttpsProxy.
`Operation`	`setSslCertificatesRegionTargetHttpsProxy(SetSslCertificatesRegionTargetHttpsProxyHttpRequest request)` Replaces SslCertificates for TargetHttpsProxy.
`Operation`	`setSslCertificatesRegionTargetHttpsProxy(String targetHttpsProxy, RegionTargetHttpsProxiesSetSslCertificatesRequest regionTargetHttpsProxiesSetSslCertificatesRequestResource)` Replaces SslCertificates for TargetHttpsProxy.
`com.google.api.gax.rpc.UnaryCallable<SetSslCertificatesRegionTargetHttpsProxyHttpRequest,Operation>`	`setSslCertificatesRegionTargetHttpsProxyCallable()` Replaces SslCertificates for TargetHttpsProxy.
`Operation`	`setUrlMapRegionTargetHttpsProxy(ProjectRegionTargetHttpsProxyName targetHttpsProxy, UrlMapReference urlMapReferenceResource)` Changes the URL map for TargetHttpsProxy.
`Operation`	`setUrlMapRegionTargetHttpsProxy(SetUrlMapRegionTargetHttpsProxyHttpRequest request)` Changes the URL map for TargetHttpsProxy.
`Operation`	`setUrlMapRegionTargetHttpsProxy(String targetHttpsProxy, UrlMapReference urlMapReferenceResource)` Changes the URL map for TargetHttpsProxy.
`com.google.api.gax.rpc.UnaryCallable<SetUrlMapRegionTargetHttpsProxyHttpRequest,Operation>`	`setUrlMapRegionTargetHttpsProxyCallable()` Changes the URL map for TargetHttpsProxy.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegionTargetHttpsProxyClient
```
protected RegionTargetHttpsProxyClient(RegionTargetHttpsProxySettings settings)
                                throws IOException
```
Constructs an instance of RegionTargetHttpsProxyClient, 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.

Throws:

IOException

RegionTargetHttpsProxyClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected RegionTargetHttpsProxyClient(RegionTargetHttpsProxyStub stub)

Method Detail

create

public static final RegionTargetHttpsProxyClient create()
                                                 throws IOException

Constructs an instance of RegionTargetHttpsProxyClient with default settings.

Throws:: IOException

create
```
public static final RegionTargetHttpsProxyClient create(RegionTargetHttpsProxySettings settings)
                                                 throws IOException
```
Constructs an instance of RegionTargetHttpsProxyClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final RegionTargetHttpsProxyClient create(RegionTargetHttpsProxyStub stub)

Constructs an instance of RegionTargetHttpsProxyClient, using the given stub for making calls. This is for advanced usage - prefer to use RegionTargetHttpsProxySettings}.

getSettings

public final RegionTargetHttpsProxySettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public RegionTargetHttpsProxyStub getStub()

deleteRegionTargetHttpsProxy

@BetaApi
public final Operation deleteRegionTargetHttpsProxy(ProjectRegionTargetHttpsProxyName targetHttpsProxy)

Deletes the specified TargetHttpsProxy resource.

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   ProjectRegionTargetHttpsProxyName targetHttpsProxy = ProjectRegionTargetHttpsProxyName.of("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   Operation response = regionTargetHttpsProxyClient.deleteRegionTargetHttpsProxy(targetHttpsProxy);
 }

Parameters:: targetHttpsProxy - Name of the TargetHttpsProxy resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteRegionTargetHttpsProxy

@BetaApi
public final Operation deleteRegionTargetHttpsProxy(String targetHttpsProxy)

Deletes the specified TargetHttpsProxy resource.

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   ProjectRegionTargetHttpsProxyName targetHttpsProxy = ProjectRegionTargetHttpsProxyName.of("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   Operation response = regionTargetHttpsProxyClient.deleteRegionTargetHttpsProxy(targetHttpsProxy.toString());
 }

Parameters:: targetHttpsProxy - Name of the TargetHttpsProxy resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteRegionTargetHttpsProxy

@BetaApi
public final Operation deleteRegionTargetHttpsProxy(DeleteRegionTargetHttpsProxyHttpRequest request)

Deletes the specified TargetHttpsProxy resource.

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   String formattedTargetHttpsProxy = ProjectRegionTargetHttpsProxyName.format("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   DeleteRegionTargetHttpsProxyHttpRequest request = DeleteRegionTargetHttpsProxyHttpRequest.newBuilder()
     .setTargetHttpsProxy(formattedTargetHttpsProxy)
     .build();
   Operation response = regionTargetHttpsProxyClient.deleteRegionTargetHttpsProxy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteRegionTargetHttpsProxyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteRegionTargetHttpsProxyHttpRequest,Operation> deleteRegionTargetHttpsProxyCallable()

Deletes the specified TargetHttpsProxy resource.

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   String formattedTargetHttpsProxy = ProjectRegionTargetHttpsProxyName.format("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   DeleteRegionTargetHttpsProxyHttpRequest request = DeleteRegionTargetHttpsProxyHttpRequest.newBuilder()
     .setTargetHttpsProxy(formattedTargetHttpsProxy)
     .build();
   ApiFuture<Operation> future = regionTargetHttpsProxyClient.deleteRegionTargetHttpsProxyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getRegionTargetHttpsProxy

@BetaApi
public final TargetHttpsProxy getRegionTargetHttpsProxy(ProjectRegionTargetHttpsProxyName targetHttpsProxy)

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

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   ProjectRegionTargetHttpsProxyName targetHttpsProxy = ProjectRegionTargetHttpsProxyName.of("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   TargetHttpsProxy response = regionTargetHttpsProxyClient.getRegionTargetHttpsProxy(targetHttpsProxy);
 }

Parameters:: targetHttpsProxy - Name of the TargetHttpsProxy resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRegionTargetHttpsProxy

@BetaApi
public final TargetHttpsProxy getRegionTargetHttpsProxy(String targetHttpsProxy)

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

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   ProjectRegionTargetHttpsProxyName targetHttpsProxy = ProjectRegionTargetHttpsProxyName.of("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   TargetHttpsProxy response = regionTargetHttpsProxyClient.getRegionTargetHttpsProxy(targetHttpsProxy.toString());
 }

Parameters:: targetHttpsProxy - Name of the TargetHttpsProxy resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRegionTargetHttpsProxy

@BetaApi
public final TargetHttpsProxy getRegionTargetHttpsProxy(GetRegionTargetHttpsProxyHttpRequest request)

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

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   String formattedTargetHttpsProxy = ProjectRegionTargetHttpsProxyName.format("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   GetRegionTargetHttpsProxyHttpRequest request = GetRegionTargetHttpsProxyHttpRequest.newBuilder()
     .setTargetHttpsProxy(formattedTargetHttpsProxy)
     .build();
   TargetHttpsProxy response = regionTargetHttpsProxyClient.getRegionTargetHttpsProxy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRegionTargetHttpsProxyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetRegionTargetHttpsProxyHttpRequest,TargetHttpsProxy> getRegionTargetHttpsProxyCallable()

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

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   String formattedTargetHttpsProxy = ProjectRegionTargetHttpsProxyName.format("[PROJECT]", "[REGION]", "[TARGET_HTTPS_PROXY]");
   GetRegionTargetHttpsProxyHttpRequest request = GetRegionTargetHttpsProxyHttpRequest.newBuilder()
     .setTargetHttpsProxy(formattedTargetHttpsProxy)
     .build();
   ApiFuture<TargetHttpsProxy> future = regionTargetHttpsProxyClient.getRegionTargetHttpsProxyCallable().futureCall(request);
   // Do something
   TargetHttpsProxy response = future.get();
 }

insertRegionTargetHttpsProxy
```
@BetaApi
public final Operation insertRegionTargetHttpsProxy(ProjectRegionName region,
                                                             TargetHttpsProxy targetHttpsProxyResource)
```
Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
Sample code:
```
 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   Operation response = regionTargetHttpsProxyClient.insertRegionTargetHttpsProxy(region, targetHttpsProxyResource);
 }
 
```
Parameters:

region - Name of the region scoping this request.

targetHttpsProxyResource - Represents a Target HTTPS Proxy resource.
A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertRegionTargetHttpsProxy
```
@BetaApi
public final Operation insertRegionTargetHttpsProxy(String region,
                                                             TargetHttpsProxy targetHttpsProxyResource)
```
Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
Sample code:
```
 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   Operation response = regionTargetHttpsProxyClient.insertRegionTargetHttpsProxy(region.toString(), targetHttpsProxyResource);
 }
 
```
Parameters:

region - Name of the region scoping this request.

targetHttpsProxyResource - Represents a Target HTTPS Proxy resource.
A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertRegionTargetHttpsProxy

@BetaApi
public final Operation insertRegionTargetHttpsProxy(InsertRegionTargetHttpsProxyHttpRequest request)

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

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   InsertRegionTargetHttpsProxyHttpRequest request = InsertRegionTargetHttpsProxyHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setTargetHttpsProxyResource(targetHttpsProxyResource)
     .build();
   Operation response = regionTargetHttpsProxyClient.insertRegionTargetHttpsProxy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

insertRegionTargetHttpsProxyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertRegionTargetHttpsProxyHttpRequest,Operation> insertRegionTargetHttpsProxyCallable()

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

Sample code:


 try (RegionTargetHttpsProxyClient regionTargetHttpsProxyClient = RegionTargetHttpsProxyClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   InsertRegionTargetHttpsProxyHttpRequest request = InsertRegionTargetHttpsProxyHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setTargetHttpsProxyResource(targetHttpsProxyResource)
     .build();
   ApiFuture<Operation> future = regionTargetHttpsProxyClient.insertRegionTargetHttpsProxyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }