ForwardingRuleClient (Google Cloud 0.119.0-alpha API)

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

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class ForwardingRuleClient
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 (ForwardingRuleClient forwardingRuleClient = ForwardingRuleClient.create()) {
   ProjectRegionForwardingRuleName forwardingRule = ProjectRegionForwardingRuleName.of("[PROJECT]", "[REGION]", "[FORWARDING_RULE]");
   Operation response = forwardingRuleClient.deleteForwardingRule(forwardingRule);
 }
 
 
```
Note: close() needs to be called on the forwardingRuleClient 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 ForwardingRuleSettings to create(). For example:
To customize credentials:
```
 
 ForwardingRuleSettings forwardingRuleSettings =
     ForwardingRuleSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ForwardingRuleClient forwardingRuleClient =
     ForwardingRuleClient.create(forwardingRuleSettings);
 
 
```
To customize the endpoint:
```
 
 ForwardingRuleSettings forwardingRuleSettings =
     ForwardingRuleSettings.newBuilder().setEndpoint(myEndpoint).build();
 ForwardingRuleClient forwardingRuleClient =
     ForwardingRuleClient.create(forwardingRuleSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ForwardingRuleClient.AggregatedListForwardingRulesFixedSizeCollection`
`static class`	`ForwardingRuleClient.AggregatedListForwardingRulesPage`
`static class`	`ForwardingRuleClient.AggregatedListForwardingRulesPagedResponse`
`static class`	`ForwardingRuleClient.ListForwardingRulesFixedSizeCollection`
`static class`	`ForwardingRuleClient.ListForwardingRulesPage`
`static class`	`ForwardingRuleClient.ListForwardingRulesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ForwardingRuleClient(ForwardingRuleSettings settings)` Constructs an instance of ForwardingRuleClient, using the given settings.
`protected`	`ForwardingRuleClient(ForwardingRuleStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ForwardingRuleClient.AggregatedListForwardingRulesPagedResponse`	`aggregatedListForwardingRules(AggregatedListForwardingRulesHttpRequest request)` Retrieves an aggregated list of forwarding rules.
`ForwardingRuleClient.AggregatedListForwardingRulesPagedResponse`	`aggregatedListForwardingRules(ProjectName project)` Retrieves an aggregated list of forwarding rules.
`ForwardingRuleClient.AggregatedListForwardingRulesPagedResponse`	`aggregatedListForwardingRules(String project)` Retrieves an aggregated list of forwarding rules.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListForwardingRulesHttpRequest,ForwardingRuleAggregatedList>`	`aggregatedListForwardingRulesCallable()` Retrieves an aggregated list of forwarding rules.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListForwardingRulesHttpRequest,ForwardingRuleClient.AggregatedListForwardingRulesPagedResponse>`	`aggregatedListForwardingRulesPagedCallable()` Retrieves an aggregated list of forwarding rules.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ForwardingRuleClient`	`create()` Constructs an instance of ForwardingRuleClient with default settings.
`static ForwardingRuleClient`	`create(ForwardingRuleSettings settings)` Constructs an instance of ForwardingRuleClient, using the given settings.
`static ForwardingRuleClient`	`create(ForwardingRuleStub stub)` Constructs an instance of ForwardingRuleClient, using the given stub for making calls.
`Operation`	`deleteForwardingRule(DeleteForwardingRuleHttpRequest request)` Deletes the specified ForwardingRule resource.
`Operation`	`deleteForwardingRule(ProjectRegionForwardingRuleName forwardingRule)` Deletes the specified ForwardingRule resource.
`Operation`	`deleteForwardingRule(String forwardingRule)` Deletes the specified ForwardingRule resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteForwardingRuleHttpRequest,Operation>`	`deleteForwardingRuleCallable()` Deletes the specified ForwardingRule resource.
`ForwardingRule`	`getForwardingRule(GetForwardingRuleHttpRequest request)` Returns the specified ForwardingRule resource.
`ForwardingRule`	`getForwardingRule(ProjectRegionForwardingRuleName forwardingRule)` Returns the specified ForwardingRule resource.
`ForwardingRule`	`getForwardingRule(String forwardingRule)` Returns the specified ForwardingRule resource.
`com.google.api.gax.rpc.UnaryCallable<GetForwardingRuleHttpRequest,ForwardingRule>`	`getForwardingRuleCallable()` Returns the specified ForwardingRule resource.
`ForwardingRuleSettings`	`getSettings()`
`ForwardingRuleStub`	`getStub()`
`Operation`	`insertForwardingRule(InsertForwardingRuleHttpRequest request)` Creates a ForwardingRule resource in the specified project and region using the data included in the request.
`Operation`	`insertForwardingRule(ProjectRegionName region, ForwardingRule forwardingRuleResource)` Creates a ForwardingRule resource in the specified project and region using the data included in the request.
`Operation`	`insertForwardingRule(String region, ForwardingRule forwardingRuleResource)` Creates a ForwardingRule resource in the specified project and region using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertForwardingRuleHttpRequest,Operation>`	`insertForwardingRuleCallable()` Creates a ForwardingRule resource in the specified project and region using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ForwardingRuleClient.ListForwardingRulesPagedResponse`	`listForwardingRules(ListForwardingRulesHttpRequest request)` Retrieves a list of ForwardingRule resources available to the specified project and region.
`ForwardingRuleClient.ListForwardingRulesPagedResponse`	`listForwardingRules(ProjectRegionName region)` Retrieves a list of ForwardingRule resources available to the specified project and region.
`ForwardingRuleClient.ListForwardingRulesPagedResponse`	`listForwardingRules(String region)` Retrieves a list of ForwardingRule resources available to the specified project and region.
`com.google.api.gax.rpc.UnaryCallable<ListForwardingRulesHttpRequest,ForwardingRuleList>`	`listForwardingRulesCallable()` Retrieves a list of ForwardingRule resources available to the specified project and region.
`com.google.api.gax.rpc.UnaryCallable<ListForwardingRulesHttpRequest,ForwardingRuleClient.ListForwardingRulesPagedResponse>`	`listForwardingRulesPagedCallable()` Retrieves a list of ForwardingRule resources available to the specified project and region.
`Operation`	`setTargetForwardingRule(ProjectRegionForwardingRuleName forwardingRule, TargetReference targetReferenceResource)` Changes target URL for forwarding rule.
`Operation`	`setTargetForwardingRule(SetTargetForwardingRuleHttpRequest request)` Changes target URL for forwarding rule.
`Operation`	`setTargetForwardingRule(String forwardingRule, TargetReference targetReferenceResource)` Changes target URL for forwarding rule.
`com.google.api.gax.rpc.UnaryCallable<SetTargetForwardingRuleHttpRequest,Operation>`	`setTargetForwardingRuleCallable()` Changes target URL for forwarding rule.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

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

Method Detail

create

public static final ForwardingRuleClient create()
                                         throws IOException

Constructs an instance of ForwardingRuleClient with default settings.

Throws:: IOException

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

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

getSettings

public final ForwardingRuleSettings getSettings()