TargetHttpProxyClient (Google Cloud 0.119.0-alpha API)

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

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class TargetHttpProxyClient
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 (TargetHttpProxyClient targetHttpProxyClient = TargetHttpProxyClient.create()) {
   ProjectGlobalTargetHttpProxyName targetHttpProxy = ProjectGlobalTargetHttpProxyName.of("[PROJECT]", "[TARGET_HTTP_PROXY]");
   Operation response = targetHttpProxyClient.deleteTargetHttpProxy(targetHttpProxy);
 }
 
 
```
Note: close() needs to be called on the targetHttpProxyClient 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 TargetHttpProxySettings to create(). For example:
To customize credentials:
```
 
 TargetHttpProxySettings targetHttpProxySettings =
     TargetHttpProxySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetHttpProxyClient targetHttpProxyClient =
     TargetHttpProxyClient.create(targetHttpProxySettings);
 
 
```
To customize the endpoint:
```
 
 TargetHttpProxySettings targetHttpProxySettings =
     TargetHttpProxySettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetHttpProxyClient targetHttpProxyClient =
     TargetHttpProxyClient.create(targetHttpProxySettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TargetHttpProxyClient.AggregatedListTargetHttpProxiesFixedSizeCollection`
`static class`	`TargetHttpProxyClient.AggregatedListTargetHttpProxiesPage`
`static class`	`TargetHttpProxyClient.AggregatedListTargetHttpProxiesPagedResponse`
`static class`	`TargetHttpProxyClient.ListTargetHttpProxiesFixedSizeCollection`
`static class`	`TargetHttpProxyClient.ListTargetHttpProxiesPage`
`static class`	`TargetHttpProxyClient.ListTargetHttpProxiesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TargetHttpProxyClient(TargetHttpProxySettings settings)` Constructs an instance of TargetHttpProxyClient, using the given settings.
`protected`	`TargetHttpProxyClient(TargetHttpProxyStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TargetHttpProxyClient.AggregatedListTargetHttpProxiesPagedResponse`	`aggregatedListTargetHttpProxies(AggregatedListTargetHttpProxiesHttpRequest request)` Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
`TargetHttpProxyClient.AggregatedListTargetHttpProxiesPagedResponse`	`aggregatedListTargetHttpProxies(ProjectName project)` Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
`TargetHttpProxyClient.AggregatedListTargetHttpProxiesPagedResponse`	`aggregatedListTargetHttpProxies(String project)` Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetHttpProxiesHttpRequest,TargetHttpProxyAggregatedList>`	`aggregatedListTargetHttpProxiesCallable()` Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetHttpProxiesHttpRequest,TargetHttpProxyClient.AggregatedListTargetHttpProxiesPagedResponse>`	`aggregatedListTargetHttpProxiesPagedCallable()` Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static TargetHttpProxyClient`	`create()` Constructs an instance of TargetHttpProxyClient with default settings.
`static TargetHttpProxyClient`	`create(TargetHttpProxySettings settings)` Constructs an instance of TargetHttpProxyClient, using the given settings.
`static TargetHttpProxyClient`	`create(TargetHttpProxyStub stub)` Constructs an instance of TargetHttpProxyClient, using the given stub for making calls.
`Operation`	`deleteTargetHttpProxy(DeleteTargetHttpProxyHttpRequest request)` Deletes the specified TargetHttpProxy resource.
`Operation`	`deleteTargetHttpProxy(ProjectGlobalTargetHttpProxyName targetHttpProxy)` Deletes the specified TargetHttpProxy resource.
`Operation`	`deleteTargetHttpProxy(String targetHttpProxy)` Deletes the specified TargetHttpProxy resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteTargetHttpProxyHttpRequest,Operation>`	`deleteTargetHttpProxyCallable()` Deletes the specified TargetHttpProxy resource.
`TargetHttpProxySettings`	`getSettings()`
`TargetHttpProxyStub`	`getStub()`
`TargetHttpProxy`	`getTargetHttpProxy(GetTargetHttpProxyHttpRequest request)` Returns the specified TargetHttpProxy resource.
`TargetHttpProxy`	`getTargetHttpProxy(ProjectGlobalTargetHttpProxyName targetHttpProxy)` Returns the specified TargetHttpProxy resource.
`TargetHttpProxy`	`getTargetHttpProxy(String targetHttpProxy)` Returns the specified TargetHttpProxy resource.
`com.google.api.gax.rpc.UnaryCallable<GetTargetHttpProxyHttpRequest,TargetHttpProxy>`	`getTargetHttpProxyCallable()` Returns the specified TargetHttpProxy resource.
`Operation`	`insertTargetHttpProxy(InsertTargetHttpProxyHttpRequest request)` Creates a TargetHttpProxy resource in the specified project using the data included in the request.
`Operation`	`insertTargetHttpProxy(ProjectName project, TargetHttpProxy targetHttpProxyResource)` Creates a TargetHttpProxy resource in the specified project using the data included in the request.
`Operation`	`insertTargetHttpProxy(String project, TargetHttpProxy targetHttpProxyResource)` Creates a TargetHttpProxy resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertTargetHttpProxyHttpRequest,Operation>`	`insertTargetHttpProxyCallable()` Creates a TargetHttpProxy resource in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`TargetHttpProxyClient.ListTargetHttpProxiesPagedResponse`	`listTargetHttpProxies(ListTargetHttpProxiesHttpRequest request)` Retrieves the list of TargetHttpProxy resources available to the specified project.
`TargetHttpProxyClient.ListTargetHttpProxiesPagedResponse`	`listTargetHttpProxies(ProjectName project)` Retrieves the list of TargetHttpProxy resources available to the specified project.
`TargetHttpProxyClient.ListTargetHttpProxiesPagedResponse`	`listTargetHttpProxies(String project)` Retrieves the list of TargetHttpProxy resources available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListTargetHttpProxiesHttpRequest,TargetHttpProxyList>`	`listTargetHttpProxiesCallable()` Retrieves the list of TargetHttpProxy resources available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListTargetHttpProxiesHttpRequest,TargetHttpProxyClient.ListTargetHttpProxiesPagedResponse>`	`listTargetHttpProxiesPagedCallable()` Retrieves the list of TargetHttpProxy resources available to the specified project.
`Operation`	`setUrlMapTargetHttpProxy(ProjectTargetHttpProxyName targetHttpProxy, UrlMapReference urlMapReferenceResource)` Changes the URL map for TargetHttpProxy.
`Operation`	`setUrlMapTargetHttpProxy(SetUrlMapTargetHttpProxyHttpRequest request)` Changes the URL map for TargetHttpProxy.
`Operation`	`setUrlMapTargetHttpProxy(String targetHttpProxy, UrlMapReference urlMapReferenceResource)` Changes the URL map for TargetHttpProxy.
`com.google.api.gax.rpc.UnaryCallable<SetUrlMapTargetHttpProxyHttpRequest,Operation>`	`setUrlMapTargetHttpProxyCallable()` Changes the URL map for TargetHttpProxy.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- TargetHttpProxyClient
```
protected TargetHttpProxyClient(TargetHttpProxySettings settings)
                         throws IOException
```
  Constructs an instance of TargetHttpProxyClient, 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
- TargetHttpProxyClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected TargetHttpProxyClient(TargetHttpProxyStub stub)
```

Method Detail

create

public static final TargetHttpProxyClient create()
                                          throws IOException

Constructs an instance of TargetHttpProxyClient with default settings.

Throws:: IOException

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

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

getSettings

public final TargetHttpProxySettings getSettings()