GlobalForwardingRulesClient (Google Compute Engine 1.59.0 API)

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

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class GlobalForwardingRulesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The GlobalForwardingRules 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   String project = "project-309310695";
   String forwardingRule = "forwardingRule-1429104743";
   ForwardingRule response = globalForwardingRulesClient.get(project, forwardingRule);
 }

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

Methods
Method	Description	Method Variants
Delete	Deletes the specified GlobalForwardingRule resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteGlobalForwardingRuleRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteAsync(String project, String forwardingRule) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetGlobalForwardingRuleRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String forwardingRule) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
Insert	Creates a GlobalForwardingRule resource in the specified project using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertGlobalForwardingRuleRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. insertAsync(String project, ForwardingRule forwardingRuleResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Retrieves a list of GlobalForwardingRule resources available to the specified project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListGlobalForwardingRulesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
Patch	Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchAsync(PatchGlobalForwardingRuleRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. patchAsync(String project, String forwardingRule, ForwardingRule forwardingRuleResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchOperationCallable() patchCallable()
SetLabels	Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setLabelsAsync(SetLabelsGlobalForwardingRuleRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setLabelsOperationCallable() setLabelsCallable()
SetTarget	Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setTargetAsync(SetTargetGlobalForwardingRuleRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setTargetAsync(String project, String forwardingRule, TargetReference targetReferenceResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setTargetOperationCallable() setTargetCallable()

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 GlobalForwardingRulesSettings 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
 GlobalForwardingRulesSettings globalForwardingRulesSettings =
     GlobalForwardingRulesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create(globalForwardingRulesSettings);

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
 GlobalForwardingRulesSettings globalForwardingRulesSettings =
     GlobalForwardingRulesSettings.newBuilder().setEndpoint(myEndpoint).build();
 GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create(globalForwardingRulesSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GlobalForwardingRulesClient.ListFixedSizeCollection`
`static class`	`GlobalForwardingRulesClient.ListPage`
`static class`	`GlobalForwardingRulesClient.ListPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GlobalForwardingRulesClient(GlobalForwardingRulesSettings settings)` Constructs an instance of GlobalForwardingRulesClient, using the given settings.
`protected`	`GlobalForwardingRulesClient(GlobalForwardingRulesStub 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 GlobalForwardingRulesClient`	`create()` Constructs an instance of GlobalForwardingRulesClient with default settings.
`static GlobalForwardingRulesClient`	`create(GlobalForwardingRulesSettings settings)` Constructs an instance of GlobalForwardingRulesClient, using the given settings.
`static GlobalForwardingRulesClient`	`create(GlobalForwardingRulesStub stub)` Constructs an instance of GlobalForwardingRulesClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`deleteAsync(DeleteGlobalForwardingRuleRequest request)` Deletes the specified GlobalForwardingRule resource.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`deleteAsync(String project, String forwardingRule)` Deletes the specified GlobalForwardingRule resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteGlobalForwardingRuleRequest,Operation>`	`deleteCallable()` Deletes the specified GlobalForwardingRule resource.
`com.google.api.gax.rpc.OperationCallable<DeleteGlobalForwardingRuleRequest,Operation,Operation>`	`deleteOperationCallable()` Deletes the specified GlobalForwardingRule resource.
`ForwardingRule`	`get(GetGlobalForwardingRuleRequest request)` Returns the specified GlobalForwardingRule resource.
`ForwardingRule`	`get(String project, String forwardingRule)` Returns the specified GlobalForwardingRule resource.
`com.google.api.gax.rpc.UnaryCallable<GetGlobalForwardingRuleRequest,ForwardingRule>`	`getCallable()` Returns the specified GlobalForwardingRule resource.
`GlobalForwardingRulesSettings`	`getSettings()`
`GlobalForwardingRulesStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`insertAsync(InsertGlobalForwardingRuleRequest request)` Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`insertAsync(String project, ForwardingRule forwardingRuleResource)` Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertGlobalForwardingRuleRequest,Operation>`	`insertCallable()` Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.OperationCallable<InsertGlobalForwardingRuleRequest,Operation,Operation>`	`insertOperationCallable()` Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`GlobalForwardingRulesClient.ListPagedResponse`	`list(ListGlobalForwardingRulesRequest request)` Retrieves a list of GlobalForwardingRule resources available to the specified project.
`GlobalForwardingRulesClient.ListPagedResponse`	`list(String project)` Retrieves a list of GlobalForwardingRule resources available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListGlobalForwardingRulesRequest,ForwardingRuleList>`	`listCallable()` Retrieves a list of GlobalForwardingRule resources available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListGlobalForwardingRulesRequest,GlobalForwardingRulesClient.ListPagedResponse>`	`listPagedCallable()` Retrieves a list of GlobalForwardingRule resources available to the specified project.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchAsync(PatchGlobalForwardingRuleRequest request)` Updates the specified forwarding rule with the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchAsync(String project, String forwardingRule, ForwardingRule forwardingRuleResource)` Updates the specified forwarding rule with the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<PatchGlobalForwardingRuleRequest,Operation>`	`patchCallable()` Updates the specified forwarding rule with the data included in the request.
`com.google.api.gax.rpc.OperationCallable<PatchGlobalForwardingRuleRequest,Operation,Operation>`	`patchOperationCallable()` Updates the specified forwarding rule with the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`setLabelsAsync(SetLabelsGlobalForwardingRuleRequest request)` Sets the labels on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)` Sets the labels on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<SetLabelsGlobalForwardingRuleRequest,Operation>`	`setLabelsCallable()` Sets the labels on the specified resource.
`com.google.api.gax.rpc.OperationCallable<SetLabelsGlobalForwardingRuleRequest,Operation,Operation>`	`setLabelsOperationCallable()` Sets the labels on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`setTargetAsync(SetTargetGlobalForwardingRuleRequest request)` Changes target URL for the GlobalForwardingRule resource.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`setTargetAsync(String project, String forwardingRule, TargetReference targetReferenceResource)` Changes target URL for the GlobalForwardingRule resource.
`com.google.api.gax.rpc.UnaryCallable<SetTargetGlobalForwardingRuleRequest,Operation>`	`setTargetCallable()` Changes target URL for the GlobalForwardingRule resource.
`com.google.api.gax.rpc.OperationCallable<SetTargetGlobalForwardingRuleRequest,Operation,Operation>`	`setTargetOperationCallable()` Changes target URL for the GlobalForwardingRule resource.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- GlobalForwardingRulesClient
```
protected GlobalForwardingRulesClient(GlobalForwardingRulesSettings settings)
                               throws IOException
```
  Constructs an instance of GlobalForwardingRulesClient, 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
- GlobalForwardingRulesClient
```
protected GlobalForwardingRulesClient(GlobalForwardingRulesStub stub)
```

Method Detail

create

public static final GlobalForwardingRulesClient create()
                                                throws IOException

Constructs an instance of GlobalForwardingRulesClient with default settings.

Throws:: IOException

create
```
public static final GlobalForwardingRulesClient create(GlobalForwardingRulesSettings settings)
                                                throws IOException
```
Constructs an instance of GlobalForwardingRulesClient, 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
```
public static final GlobalForwardingRulesClient create(GlobalForwardingRulesStub stub)
```
Constructs an instance of GlobalForwardingRulesClient, using the given stub for making calls. This is for advanced usage - prefer using create(GlobalForwardingRulesSettings).

getSettings

public final GlobalForwardingRulesSettings getSettings()

getStub

public GlobalForwardingRulesStub getStub()

deleteAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project,
                                                                                             String forwardingRule)

Deletes the specified GlobalForwardingRule 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   String project = "project-309310695";
   String forwardingRule = "forwardingRule-1429104743";
   Operation response = globalForwardingRulesClient.deleteAsync(project, forwardingRule).get();
 }

Parameters:: project - Project ID for this request.; forwardingRule - Name of the ForwardingRule resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteGlobalForwardingRuleRequest request)

Deletes the specified GlobalForwardingRule 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   DeleteGlobalForwardingRuleRequest request =
       DeleteGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = globalForwardingRulesClient.deleteAsync(request).get();
 }

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

deleteOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteGlobalForwardingRuleRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified GlobalForwardingRule 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   DeleteGlobalForwardingRuleRequest request =
       DeleteGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       globalForwardingRulesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

deleteCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteGlobalForwardingRuleRequest,Operation> deleteCallable()

Deletes the specified GlobalForwardingRule 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   DeleteGlobalForwardingRuleRequest request =
       DeleteGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       globalForwardingRulesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

get

public final ForwardingRule get(String project,
                                String forwardingRule)

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   String project = "project-309310695";
   String forwardingRule = "forwardingRule-1429104743";
   ForwardingRule response = globalForwardingRulesClient.get(project, forwardingRule);
 }

Parameters:: project - Project ID for this request.; forwardingRule - Name of the ForwardingRule resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

get

public final ForwardingRule get(GetGlobalForwardingRuleRequest request)

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   GetGlobalForwardingRuleRequest request =
       GetGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .build();
   ForwardingRule response = globalForwardingRulesClient.get(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

getCallable

public final com.google.api.gax.rpc.UnaryCallable<GetGlobalForwardingRuleRequest,ForwardingRule> getCallable()

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   GetGlobalForwardingRuleRequest request =
       GetGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .build();
   ApiFuture<ForwardingRule> future =
       globalForwardingRulesClient.getCallable().futureCall(request);
   // Do something.
   ForwardingRule response = future.get();
 }

insertAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project,
                                                                                             ForwardingRule forwardingRuleResource)

Creates a GlobalForwardingRule resource in the specified project 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   String project = "project-309310695";
   ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
   Operation response =
       globalForwardingRulesClient.insertAsync(project, forwardingRuleResource).get();
 }

Parameters:: project - Project ID for this request.; forwardingRuleResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

insertAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertGlobalForwardingRuleRequest request)

Creates a GlobalForwardingRule resource in the specified project 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   InsertGlobalForwardingRuleRequest request =
       InsertGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = globalForwardingRulesClient.insertAsync(request).get();
 }

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

insertOperationCallable

public final com.google.api.gax.rpc.OperationCallable<InsertGlobalForwardingRuleRequest,Operation,Operation> insertOperationCallable()

Creates a GlobalForwardingRule resource in the specified project 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   InsertGlobalForwardingRuleRequest request =
       InsertGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       globalForwardingRulesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

insertCallable

public final com.google.api.gax.rpc.UnaryCallable<InsertGlobalForwardingRuleRequest,Operation> insertCallable()

Creates a GlobalForwardingRule resource in the specified project 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   InsertGlobalForwardingRuleRequest request =
       InsertGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       globalForwardingRulesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

list

public final GlobalForwardingRulesClient.ListPagedResponse list(String project)

Retrieves a list of GlobalForwardingRule resources available to the specified project.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   String project = "project-309310695";
   for (ForwardingRule element : globalForwardingRulesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

list

public final GlobalForwardingRulesClient.ListPagedResponse list(ListGlobalForwardingRulesRequest request)

Retrieves a list of GlobalForwardingRule resources available to the specified project.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   ListGlobalForwardingRulesRequest request =
       ListGlobalForwardingRulesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (ForwardingRule element : globalForwardingRulesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

listPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGlobalForwardingRulesRequest,GlobalForwardingRulesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of GlobalForwardingRule resources available to the specified project.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   ListGlobalForwardingRulesRequest request =
       ListGlobalForwardingRulesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<ForwardingRule> future =
       globalForwardingRulesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (ForwardingRule element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGlobalForwardingRulesRequest,ForwardingRuleList> listCallable()

Retrieves a list of GlobalForwardingRule resources available to the specified project.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   ListGlobalForwardingRulesRequest request =
       ListGlobalForwardingRulesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     ForwardingRuleList response = globalForwardingRulesClient.listCallable().call(request);
     for (ForwardingRule element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

patchAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(String project,
                                                                                            String forwardingRule,
                                                                                            ForwardingRule forwardingRuleResource)

Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   String project = "project-309310695";
   String forwardingRule = "forwardingRule-1429104743";
   ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
   Operation response =
       globalForwardingRulesClient
           .patchAsync(project, forwardingRule, forwardingRuleResource)
           .get();
 }

Parameters:: project - Project ID for this request.; forwardingRule - Name of the ForwardingRule resource to patch.; forwardingRuleResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

patchAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(PatchGlobalForwardingRuleRequest 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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   PatchGlobalForwardingRuleRequest request =
       PatchGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = globalForwardingRulesClient.patchAsync(request).get();
 }

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

patchOperationCallable

public final com.google.api.gax.rpc.OperationCallable<PatchGlobalForwardingRuleRequest,Operation,Operation> patchOperationCallable()

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   PatchGlobalForwardingRuleRequest request =
       PatchGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       globalForwardingRulesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

patchCallable

public final com.google.api.gax.rpc.UnaryCallable<PatchGlobalForwardingRuleRequest,Operation> patchCallable()

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   PatchGlobalForwardingRuleRequest request =
       PatchGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = globalForwardingRulesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

setLabelsAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(String project,
                                                                                                String resource,
                                                                                                GlobalSetLabelsRequest globalSetLabelsRequestResource)

Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   String project = "project-309310695";
   String resource = "resource-341064690";
   GlobalSetLabelsRequest globalSetLabelsRequestResource =
       GlobalSetLabelsRequest.newBuilder().build();
   Operation response =
       globalForwardingRulesClient
           .setLabelsAsync(project, resource, globalSetLabelsRequestResource)
           .get();
 }

Parameters:: project - Project ID for this request.; resource - Name or id of the resource for this request.; globalSetLabelsRequestResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

setLabelsAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsGlobalForwardingRuleRequest request)

Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   SetLabelsGlobalForwardingRuleRequest request =
       SetLabelsGlobalForwardingRuleRequest.newBuilder()
           .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   Operation response = globalForwardingRulesClient.setLabelsAsync(request).get();
 }

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

setLabelsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<SetLabelsGlobalForwardingRuleRequest,Operation,Operation> setLabelsOperationCallable()

Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   SetLabelsGlobalForwardingRuleRequest request =
       SetLabelsGlobalForwardingRuleRequest.newBuilder()
           .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   OperationFuture<Operation, Operation> future =
       globalForwardingRulesClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

setLabelsCallable

public final com.google.api.gax.rpc.UnaryCallable<SetLabelsGlobalForwardingRuleRequest,Operation> setLabelsCallable()

Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   SetLabelsGlobalForwardingRuleRequest request =
       SetLabelsGlobalForwardingRuleRequest.newBuilder()
           .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Operation> future =
       globalForwardingRulesClient.setLabelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

setTargetAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setTargetAsync(String project,
                                                                                                String forwardingRule,
                                                                                                TargetReference targetReferenceResource)

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   String project = "project-309310695";
   String forwardingRule = "forwardingRule-1429104743";
   TargetReference targetReferenceResource = TargetReference.newBuilder().build();
   Operation response =
       globalForwardingRulesClient
           .setTargetAsync(project, forwardingRule, targetReferenceResource)
           .get();
 }

Parameters:: project - Project ID for this request.; forwardingRule - Name of the ForwardingRule resource in which target is to be set.; targetReferenceResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

setTargetAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setTargetAsync(SetTargetGlobalForwardingRuleRequest request)

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   SetTargetGlobalForwardingRuleRequest request =
       SetTargetGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetReferenceResource(TargetReference.newBuilder().build())
           .build();
   Operation response = globalForwardingRulesClient.setTargetAsync(request).get();
 }

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

setTargetOperationCallable

public final com.google.api.gax.rpc.OperationCallable<SetTargetGlobalForwardingRuleRequest,Operation,Operation> setTargetOperationCallable()

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   SetTargetGlobalForwardingRuleRequest request =
       SetTargetGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetReferenceResource(TargetReference.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       globalForwardingRulesClient.setTargetOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

setTargetCallable

public final com.google.api.gax.rpc.UnaryCallable<SetTargetGlobalForwardingRuleRequest,Operation> setTargetCallable()

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

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 (GlobalForwardingRulesClient globalForwardingRulesClient =
     GlobalForwardingRulesClient.create()) {
   SetTargetGlobalForwardingRuleRequest request =
       SetTargetGlobalForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetReferenceResource(TargetReference.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       globalForwardingRulesClient.setTargetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class GlobalForwardingRulesClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlobalForwardingRulesClient

GlobalForwardingRulesClient

Method Detail

create

create

create

getSettings

getStub

deleteAsync

deleteAsync

deleteOperationCallable

deleteCallable

get

get

getCallable

insertAsync

insertAsync

insertOperationCallable

insertCallable

list

list

listPagedCallable

listCallable

patchAsync

patchAsync

patchOperationCallable

patchCallable

setLabelsAsync

setLabelsAsync

setLabelsOperationCallable

setLabelsCallable

setTargetAsync

setTargetAsync

setTargetOperationCallable

setTargetCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination