TargetHttpsProxyClient (Google Cloud 0.90.0-alpha API)

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

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class TargetHttpsProxyClient
extends Object
implements 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 (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   ProjectGlobalTargetHttpsProxyName targetHttpsProxy = ProjectGlobalTargetHttpsProxyName.of("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   Operation response = targetHttpsProxyClient.deleteTargetHttpsProxy(targetHttpsProxy);
 }
 
 
```
Note: close() needs to be called on the targetHttpsProxyClient 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 TargetHttpsProxySettings to create(). For example:
To customize credentials:
```
 
 TargetHttpsProxySettings targetHttpsProxySettings =
     TargetHttpsProxySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetHttpsProxyClient targetHttpsProxyClient =
     TargetHttpsProxyClient.create(targetHttpsProxySettings);
 
 
```
To customize the endpoint:
```
 
 TargetHttpsProxySettings targetHttpsProxySettings =
     TargetHttpsProxySettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetHttpsProxyClient targetHttpsProxyClient =
     TargetHttpsProxyClient.create(targetHttpsProxySettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TargetHttpsProxyClient.ListTargetHttpsProxiesFixedSizeCollection`
`static class`	`TargetHttpsProxyClient.ListTargetHttpsProxiesPage`
`static class`	`TargetHttpsProxyClient.ListTargetHttpsProxiesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TargetHttpsProxyClient(TargetHttpsProxySettings settings)` Constructs an instance of TargetHttpsProxyClient, using the given settings.
`protected`	`TargetHttpsProxyClient(TargetHttpsProxyStub 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 TargetHttpsProxyClient`	`create()` Constructs an instance of TargetHttpsProxyClient with default settings.
`static TargetHttpsProxyClient`	`create(TargetHttpsProxySettings settings)` Constructs an instance of TargetHttpsProxyClient, using the given settings.
`static TargetHttpsProxyClient`	`create(TargetHttpsProxyStub stub)` Constructs an instance of TargetHttpsProxyClient, using the given stub for making calls.
`Operation`	`deleteTargetHttpsProxy(DeleteTargetHttpsProxyHttpRequest request)` Deletes the specified TargetHttpsProxy resource.
`Operation`	`deleteTargetHttpsProxy(ProjectGlobalTargetHttpsProxyName targetHttpsProxy)` Deletes the specified TargetHttpsProxy resource.
`Operation`	`deleteTargetHttpsProxy(String targetHttpsProxy)` Deletes the specified TargetHttpsProxy resource.
`UnaryCallable<DeleteTargetHttpsProxyHttpRequest,Operation>`	`deleteTargetHttpsProxyCallable()` Deletes the specified TargetHttpsProxy resource.
`TargetHttpsProxySettings`	`getSettings()`
`TargetHttpsProxyStub`	`getStub()`
`TargetHttpsProxy`	`getTargetHttpsProxy(GetTargetHttpsProxyHttpRequest request)` Returns the specified TargetHttpsProxy resource.
`TargetHttpsProxy`	`getTargetHttpsProxy(ProjectGlobalTargetHttpsProxyName targetHttpsProxy)` Returns the specified TargetHttpsProxy resource.
`TargetHttpsProxy`	`getTargetHttpsProxy(String targetHttpsProxy)` Returns the specified TargetHttpsProxy resource.
`UnaryCallable<GetTargetHttpsProxyHttpRequest,TargetHttpsProxy>`	`getTargetHttpsProxyCallable()` Returns the specified TargetHttpsProxy resource.
`Operation`	`insertTargetHttpsProxy(InsertTargetHttpsProxyHttpRequest request)` Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
`Operation`	`insertTargetHttpsProxy(ProjectName project, TargetHttpsProxy targetHttpsProxyResource)` Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
`Operation`	`insertTargetHttpsProxy(String project, TargetHttpsProxy targetHttpsProxyResource)` Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
`UnaryCallable<InsertTargetHttpsProxyHttpRequest,Operation>`	`insertTargetHttpsProxyCallable()` Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`TargetHttpsProxyClient.ListTargetHttpsProxiesPagedResponse`	`listTargetHttpsProxies(ListTargetHttpsProxiesHttpRequest request)` Retrieves the list of TargetHttpsProxy resources available to the specified project.
`TargetHttpsProxyClient.ListTargetHttpsProxiesPagedResponse`	`listTargetHttpsProxies(ProjectName project)` Retrieves the list of TargetHttpsProxy resources available to the specified project.
`TargetHttpsProxyClient.ListTargetHttpsProxiesPagedResponse`	`listTargetHttpsProxies(String project)` Retrieves the list of TargetHttpsProxy resources available to the specified project.
`UnaryCallable<ListTargetHttpsProxiesHttpRequest,TargetHttpsProxyList>`	`listTargetHttpsProxiesCallable()` Retrieves the list of TargetHttpsProxy resources available to the specified project.
`UnaryCallable<ListTargetHttpsProxiesHttpRequest,TargetHttpsProxyClient.ListTargetHttpsProxiesPagedResponse>`	`listTargetHttpsProxiesPagedCallable()` Retrieves the list of TargetHttpsProxy resources available to the specified project.
`Operation`	`setQuicOverrideTargetHttpsProxy(ProjectGlobalTargetHttpsProxyName targetHttpsProxy, TargetHttpsProxiesSetQuicOverrideRequest targetHttpsProxiesSetQuicOverrideRequestResource)` Sets the QUIC override policy for TargetHttpsProxy.
`Operation`	`setQuicOverrideTargetHttpsProxy(SetQuicOverrideTargetHttpsProxyHttpRequest request)` Sets the QUIC override policy for TargetHttpsProxy.
`Operation`	`setQuicOverrideTargetHttpsProxy(String targetHttpsProxy, TargetHttpsProxiesSetQuicOverrideRequest targetHttpsProxiesSetQuicOverrideRequestResource)` Sets the QUIC override policy for TargetHttpsProxy.
`UnaryCallable<SetQuicOverrideTargetHttpsProxyHttpRequest,Operation>`	`setQuicOverrideTargetHttpsProxyCallable()` Sets the QUIC override policy for TargetHttpsProxy.
`Operation`	`setSslCertificatesTargetHttpsProxy(ProjectTargetHttpsProxyName targetHttpsProxy, TargetHttpsProxiesSetSslCertificatesRequest targetHttpsProxiesSetSslCertificatesRequestResource)` Replaces SslCertificates for TargetHttpsProxy.
`Operation`	`setSslCertificatesTargetHttpsProxy(SetSslCertificatesTargetHttpsProxyHttpRequest request)` Replaces SslCertificates for TargetHttpsProxy.
`Operation`	`setSslCertificatesTargetHttpsProxy(String targetHttpsProxy, TargetHttpsProxiesSetSslCertificatesRequest targetHttpsProxiesSetSslCertificatesRequestResource)` Replaces SslCertificates for TargetHttpsProxy.
`UnaryCallable<SetSslCertificatesTargetHttpsProxyHttpRequest,Operation>`	`setSslCertificatesTargetHttpsProxyCallable()` Replaces SslCertificates for TargetHttpsProxy.
`Operation`	`setSslPolicyTargetHttpsProxy(ProjectGlobalTargetHttpsProxyName targetHttpsProxy, SslPolicyReference sslPolicyReferenceResource)` Sets the SSL policy for TargetHttpsProxy.
`Operation`	`setSslPolicyTargetHttpsProxy(SetSslPolicyTargetHttpsProxyHttpRequest request)` Sets the SSL policy for TargetHttpsProxy.
`Operation`	`setSslPolicyTargetHttpsProxy(String targetHttpsProxy, SslPolicyReference sslPolicyReferenceResource)` Sets the SSL policy for TargetHttpsProxy.
`UnaryCallable<SetSslPolicyTargetHttpsProxyHttpRequest,Operation>`	`setSslPolicyTargetHttpsProxyCallable()` Sets the SSL policy for TargetHttpsProxy.
`Operation`	`setUrlMapTargetHttpsProxy(ProjectTargetHttpsProxyName targetHttpsProxy, UrlMapReference urlMapReferenceResource)` Changes the URL map for TargetHttpsProxy.
`Operation`	`setUrlMapTargetHttpsProxy(SetUrlMapTargetHttpsProxyHttpRequest request)` Changes the URL map for TargetHttpsProxy.
`Operation`	`setUrlMapTargetHttpsProxy(String targetHttpsProxy, UrlMapReference urlMapReferenceResource)` Changes the URL map for TargetHttpsProxy.
`UnaryCallable<SetUrlMapTargetHttpsProxyHttpRequest,Operation>`	`setUrlMapTargetHttpsProxyCallable()` 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
- TargetHttpsProxyClient
```
protected TargetHttpsProxyClient(TargetHttpsProxySettings settings)
                          throws IOException
```
  Constructs an instance of TargetHttpsProxyClient, 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
- TargetHttpsProxyClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected TargetHttpsProxyClient(TargetHttpsProxyStub stub)
```

Method Detail

create

public static final TargetHttpsProxyClient create()
                                           throws IOException

Constructs an instance of TargetHttpsProxyClient with default settings.

Throws:: IOException

create
```
public static final TargetHttpsProxyClient create(TargetHttpsProxySettings settings)
                                           throws IOException
```
Constructs an instance of TargetHttpsProxyClient, 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 TargetHttpsProxyClient create(TargetHttpsProxyStub stub)

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

getSettings

public final TargetHttpsProxySettings getSettings()

getStub

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

deleteTargetHttpsProxy

@BetaApi
public final Operation deleteTargetHttpsProxy(ProjectGlobalTargetHttpsProxyName targetHttpsProxy)

Deletes the specified TargetHttpsProxy resource.

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   ProjectGlobalTargetHttpsProxyName targetHttpsProxy = ProjectGlobalTargetHttpsProxyName.of("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   Operation response = targetHttpsProxyClient.deleteTargetHttpsProxy(targetHttpsProxy);
 }

Parameters:: targetHttpsProxy - Name of the TargetHttpsProxy resource to delete.
Throws:: ApiException - if the remote call fails

deleteTargetHttpsProxy

@BetaApi
public final Operation deleteTargetHttpsProxy(String targetHttpsProxy)

Deletes the specified TargetHttpsProxy resource.

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   ProjectGlobalTargetHttpsProxyName targetHttpsProxy = ProjectGlobalTargetHttpsProxyName.of("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   Operation response = targetHttpsProxyClient.deleteTargetHttpsProxy(targetHttpsProxy.toString());
 }

Parameters:: targetHttpsProxy - Name of the TargetHttpsProxy resource to delete.
Throws:: ApiException - if the remote call fails

deleteTargetHttpsProxy

@BetaApi
public final Operation deleteTargetHttpsProxy(DeleteTargetHttpsProxyHttpRequest request)

Deletes the specified TargetHttpsProxy resource.

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   String formattedTargetHttpsProxy = ProjectGlobalTargetHttpsProxyName.format("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   DeleteTargetHttpsProxyHttpRequest request = DeleteTargetHttpsProxyHttpRequest.newBuilder()
     .setTargetHttpsProxy(formattedTargetHttpsProxy)
     .build();
   Operation response = targetHttpsProxyClient.deleteTargetHttpsProxy(request);
 }

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

deleteTargetHttpsProxyCallable

@BetaApi
public final UnaryCallable<DeleteTargetHttpsProxyHttpRequest,Operation> deleteTargetHttpsProxyCallable()

Deletes the specified TargetHttpsProxy resource.

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   String formattedTargetHttpsProxy = ProjectGlobalTargetHttpsProxyName.format("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   DeleteTargetHttpsProxyHttpRequest request = DeleteTargetHttpsProxyHttpRequest.newBuilder()
     .setTargetHttpsProxy(formattedTargetHttpsProxy)
     .build();
   ApiFuture<Operation> future = targetHttpsProxyClient.deleteTargetHttpsProxyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getTargetHttpsProxy

@BetaApi
public final TargetHttpsProxy getTargetHttpsProxy(ProjectGlobalTargetHttpsProxyName targetHttpsProxy)

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

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   ProjectGlobalTargetHttpsProxyName targetHttpsProxy = ProjectGlobalTargetHttpsProxyName.of("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   TargetHttpsProxy response = targetHttpsProxyClient.getTargetHttpsProxy(targetHttpsProxy);
 }

Parameters:: targetHttpsProxy - Name of the TargetHttpsProxy resource to return.
Throws:: ApiException - if the remote call fails

getTargetHttpsProxy

@BetaApi
public final TargetHttpsProxy getTargetHttpsProxy(String targetHttpsProxy)

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

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   ProjectGlobalTargetHttpsProxyName targetHttpsProxy = ProjectGlobalTargetHttpsProxyName.of("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   TargetHttpsProxy response = targetHttpsProxyClient.getTargetHttpsProxy(targetHttpsProxy.toString());
 }

Parameters:: targetHttpsProxy - Name of the TargetHttpsProxy resource to return.
Throws:: ApiException - if the remote call fails

getTargetHttpsProxy

@BetaApi
public final TargetHttpsProxy getTargetHttpsProxy(GetTargetHttpsProxyHttpRequest request)

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

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   String formattedTargetHttpsProxy = ProjectGlobalTargetHttpsProxyName.format("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   GetTargetHttpsProxyHttpRequest request = GetTargetHttpsProxyHttpRequest.newBuilder()
     .setTargetHttpsProxy(formattedTargetHttpsProxy)
     .build();
   TargetHttpsProxy response = targetHttpsProxyClient.getTargetHttpsProxy(request);
 }

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

getTargetHttpsProxyCallable

@BetaApi
public final UnaryCallable<GetTargetHttpsProxyHttpRequest,TargetHttpsProxy> getTargetHttpsProxyCallable()

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

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   String formattedTargetHttpsProxy = ProjectGlobalTargetHttpsProxyName.format("[PROJECT]", "[TARGET_HTTPS_PROXY]");
   GetTargetHttpsProxyHttpRequest request = GetTargetHttpsProxyHttpRequest.newBuilder()
     .setTargetHttpsProxy(formattedTargetHttpsProxy)
     .build();
   ApiFuture<TargetHttpsProxy> future = targetHttpsProxyClient.getTargetHttpsProxyCallable().futureCall(request);
   // Do something
   TargetHttpsProxy response = future.get();
 }

insertTargetHttpsProxy

@BetaApi
public final Operation insertTargetHttpsProxy(ProjectName project,
                                                       TargetHttpsProxy targetHttpsProxyResource)

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

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   Operation response = targetHttpsProxyClient.insertTargetHttpsProxy(project, targetHttpsProxyResource);
 }

Parameters:: project - Project ID for this request.; targetHttpsProxyResource - A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Throws:: ApiException - if the remote call fails

insertTargetHttpsProxy

@BetaApi
public final Operation insertTargetHttpsProxy(String project,
                                                       TargetHttpsProxy targetHttpsProxyResource)

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

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   Operation response = targetHttpsProxyClient.insertTargetHttpsProxy(project.toString(), targetHttpsProxyResource);
 }

Parameters:: project - Project ID for this request.; targetHttpsProxyResource - A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Throws:: ApiException - if the remote call fails

insertTargetHttpsProxy

@BetaApi
public final Operation insertTargetHttpsProxy(InsertTargetHttpsProxyHttpRequest request)

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

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   InsertTargetHttpsProxyHttpRequest request = InsertTargetHttpsProxyHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setTargetHttpsProxyResource(targetHttpsProxyResource)
     .build();
   Operation response = targetHttpsProxyClient.insertTargetHttpsProxy(request);
 }

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

insertTargetHttpsProxyCallable

@BetaApi
public final UnaryCallable<InsertTargetHttpsProxyHttpRequest,Operation> insertTargetHttpsProxyCallable()

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

Sample code:


 try (TargetHttpsProxyClient targetHttpsProxyClient = TargetHttpsProxyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   TargetHttpsProxy targetHttpsProxyResource = TargetHttpsProxy.newBuilder().build();
   InsertTargetHttpsProxyHttpRequest request = InsertTargetHttpsProxyHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setTargetHttpsProxyResource(targetHttpsProxyResource)
     .build();
   ApiFuture<Operation> future = targetHttpsProxyClient.insertTargetHttpsProxyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }