Class ForwardingRulesClient (1.30.0)

Version 1.30.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class ForwardingRulesClient implements BackgroundResource

Service Description: The ForwardingRules 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String forwardingRule = "forwardingRule-1429104743";
   ForwardingRule response = forwardingRulesClient.get(project, region, forwardingRule);
 }
 

Note: close() needs to be called on the ForwardingRulesClient 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 ForwardingRulesSettings 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
 ForwardingRulesSettings forwardingRulesSettings =
     ForwardingRulesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ForwardingRulesClient forwardingRulesClient =
     ForwardingRulesClient.create(forwardingRulesSettings);
 

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
 ForwardingRulesSettings forwardingRulesSettings =
     ForwardingRulesSettings.newBuilder().setEndpoint(myEndpoint).build();
 ForwardingRulesClient forwardingRulesClient =
     ForwardingRulesClient.create(forwardingRulesSettings);
 

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

Inheritance

java.lang.Object > ForwardingRulesClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ForwardingRulesClient create()

Constructs an instance of ForwardingRulesClient with default settings.

Returns
Type	Description
ForwardingRulesClient

Exceptions
Type	Description
IOException

create(ForwardingRulesSettings settings)

public static final ForwardingRulesClient create(ForwardingRulesSettings settings)

Constructs an instance of ForwardingRulesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
settings	ForwardingRulesSettings

Returns
Type	Description
ForwardingRulesClient

Exceptions
Type	Description
IOException

create(ForwardingRulesStub stub)

public static final ForwardingRulesClient create(ForwardingRulesStub stub)

Constructs an instance of ForwardingRulesClient, using the given stub for making calls. This is for advanced usage - prefer using create(ForwardingRulesSettings).

Parameter
Name	Description
stub	ForwardingRulesStub

Returns
Type	Description
ForwardingRulesClient

Constructors

ForwardingRulesClient(ForwardingRulesSettings settings)

protected ForwardingRulesClient(ForwardingRulesSettings settings)

Constructs an instance of ForwardingRulesClient, 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.

Parameter
Name	Description
settings	ForwardingRulesSettings

ForwardingRulesClient(ForwardingRulesStub stub)

protected ForwardingRulesClient(ForwardingRulesStub stub)

Parameter
Name	Description
stub	ForwardingRulesStub

Methods

aggregatedList(AggregatedListForwardingRulesRequest request)

public final ForwardingRulesClient.AggregatedListPagedResponse aggregatedList(AggregatedListForwardingRulesRequest request)

Retrieves an aggregated list of forwarding rules.

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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   AggregatedListForwardingRulesRequest request =
       AggregatedListForwardingRulesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, ForwardingRulesScopedList> element :
       forwardingRulesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	AggregatedListForwardingRulesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ForwardingRulesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final ForwardingRulesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of forwarding rules.

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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, ForwardingRulesScopedList> element :
       forwardingRulesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
project	String Project ID for this request.

Returns
Type	Description
ForwardingRulesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListForwardingRulesRequest,ForwardingRuleAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of forwarding rules.

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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   AggregatedListForwardingRulesRequest request =
       AggregatedListForwardingRulesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     ForwardingRuleAggregatedList response =
         forwardingRulesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, ForwardingRulesScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<AggregatedListForwardingRulesRequest,ForwardingRuleAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListForwardingRulesRequest,ForwardingRulesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of forwarding rules.

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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   AggregatedListForwardingRulesRequest request =
       AggregatedListForwardingRulesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, ForwardingRulesScopedList>> future =
       forwardingRulesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, ForwardingRulesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<AggregatedListForwardingRulesRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteForwardingRuleRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteForwardingRuleRequest request)

Deletes the specified ForwardingRule 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   DeleteForwardingRuleRequest request =
       DeleteForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = forwardingRulesClient.deleteAsync(request).get();
 }
 

Parameter
Name	Description
request	DeleteForwardingRuleRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String forwardingRule)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String forwardingRule)

Deletes the specified ForwardingRule 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String forwardingRule = "forwardingRule-1429104743";
   Operation response = forwardingRulesClient.deleteAsync(project, region, forwardingRule).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
forwardingRule	String Name of the ForwardingRule resource to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteForwardingRuleRequest,Operation> deleteCallable()

Deletes the specified ForwardingRule 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   DeleteForwardingRuleRequest request =
       DeleteForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = forwardingRulesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteForwardingRuleRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteForwardingRuleRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified ForwardingRule 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   DeleteForwardingRuleRequest request =
       DeleteForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       forwardingRulesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteForwardingRuleRequest,Operation,Operation>

get(GetForwardingRuleRequest request)

public final ForwardingRule get(GetForwardingRuleRequest request)

Returns the specified ForwardingRule 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   GetForwardingRuleRequest request =
       GetForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ForwardingRule response = forwardingRulesClient.get(request);
 }
 

Parameter
Name	Description
request	GetForwardingRuleRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ForwardingRule

get(String project, String region, String forwardingRule)

public final ForwardingRule get(String project, String region, String forwardingRule)

Returns the specified ForwardingRule 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String forwardingRule = "forwardingRule-1429104743";
   ForwardingRule response = forwardingRulesClient.get(project, region, forwardingRule);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
forwardingRule	String Name of the ForwardingRule resource to return.

Returns
Type	Description
ForwardingRule

getCallable()

public final UnaryCallable<GetForwardingRuleRequest,ForwardingRule> getCallable()

Returns the specified ForwardingRule 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   GetForwardingRuleRequest request =
       GetForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<ForwardingRule> future = forwardingRulesClient.getCallable().futureCall(request);
   // Do something.
   ForwardingRule response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetForwardingRuleRequest,ForwardingRule>

getSettings()

public final ForwardingRulesSettings getSettings()

Returns
Type	Description
ForwardingRulesSettings

getStub()

public ForwardingRulesStub getStub()

Returns
Type	Description
ForwardingRulesStub

insertAsync(InsertForwardingRuleRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertForwardingRuleRequest request)

Creates a ForwardingRule resource in the specified project and region 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   InsertForwardingRuleRequest request =
       InsertForwardingRuleRequest.newBuilder()
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = forwardingRulesClient.insertAsync(request).get();
 }
 

Parameter
Name	Description
request	InsertForwardingRuleRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, ForwardingRule forwardingRuleResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, ForwardingRule forwardingRuleResource)

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

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
forwardingRuleResource	ForwardingRule The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertForwardingRuleRequest,Operation> insertCallable()

Creates a ForwardingRule resource in the specified project and region 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   InsertForwardingRuleRequest request =
       InsertForwardingRuleRequest.newBuilder()
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = forwardingRulesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<InsertForwardingRuleRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertForwardingRuleRequest,Operation,Operation> insertOperationCallable()

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

Returns
Type	Description
OperationCallable<InsertForwardingRuleRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListForwardingRulesRequest request)

public final ForwardingRulesClient.ListPagedResponse list(ListForwardingRulesRequest request)

Retrieves a list of ForwardingRule resources available to the specified project and region.

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

Parameter
Name	Description
request	ListForwardingRulesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ForwardingRulesClient.ListPagedResponse

list(String project, String region)

public final ForwardingRulesClient.ListPagedResponse list(String project, String region)

Retrieves a list of ForwardingRule resources available to the specified project and region.

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

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.

Returns
Type	Description
ForwardingRulesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListForwardingRulesRequest,ForwardingRuleList> listCallable()

Retrieves a list of ForwardingRule resources available to the specified project and region.

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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   ListForwardingRulesRequest request =
       ListForwardingRulesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     ForwardingRuleList response = forwardingRulesClient.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;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListForwardingRulesRequest,ForwardingRuleList>

listPagedCallable()

public final UnaryCallable<ListForwardingRulesRequest,ForwardingRulesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of ForwardingRule resources available to the specified project and region.

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

Returns
Type	Description
UnaryCallable<ListForwardingRulesRequest,ListPagedResponse>

patchAsync(PatchForwardingRuleRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchForwardingRuleRequest request)

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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   PatchForwardingRuleRequest request =
       PatchForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setForwardingRuleResource(ForwardingRule.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = forwardingRulesClient.patchAsync(request).get();
 }
 

Parameter
Name	Description
request	PatchForwardingRuleRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String region, String forwardingRule, ForwardingRule forwardingRuleResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String forwardingRule = "forwardingRule-1429104743";
   ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
   Operation response =
       forwardingRulesClient
           .patchAsync(project, region, forwardingRule, forwardingRuleResource)
           .get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
forwardingRule	String Name of the ForwardingRule resource to patch.
forwardingRuleResource	ForwardingRule The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchForwardingRuleRequest,Operation> patchCallable()

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

Returns
Type	Description
UnaryCallable<PatchForwardingRuleRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchForwardingRuleRequest,Operation,Operation> patchOperationCallable()

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

Returns
Type	Description
OperationCallable<PatchForwardingRuleRequest,Operation,Operation>

setLabelsAsync(SetLabelsForwardingRuleRequest request)

public final OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsForwardingRuleRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   SetLabelsForwardingRuleRequest request =
       SetLabelsForwardingRuleRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   Operation response = forwardingRulesClient.setLabelsAsync(request).get();
 }
 

Parameter
Name	Description
request	SetLabelsForwardingRuleRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)

public final OperationFuture<Operation,Operation> setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)

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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   RegionSetLabelsRequest regionSetLabelsRequestResource =
       RegionSetLabelsRequest.newBuilder().build();
   Operation response =
       forwardingRulesClient
           .setLabelsAsync(project, region, resource, regionSetLabelsRequestResource)
           .get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The region for this request.
resource	String Name or id of the resource for this request.
regionSetLabelsRequestResource	RegionSetLabelsRequest The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

setLabelsCallable()

public final UnaryCallable<SetLabelsForwardingRuleRequest,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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   SetLabelsForwardingRuleRequest request =
       SetLabelsForwardingRuleRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Operation> future = forwardingRulesClient.setLabelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<SetLabelsForwardingRuleRequest,Operation>

setLabelsOperationCallable()

public final OperationCallable<SetLabelsForwardingRuleRequest,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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   SetLabelsForwardingRuleRequest request =
       SetLabelsForwardingRuleRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   OperationFuture<Operation, Operation> future =
       forwardingRulesClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<SetLabelsForwardingRuleRequest,Operation,Operation>

setTargetAsync(SetTargetForwardingRuleRequest request)

public final OperationFuture<Operation,Operation> setTargetAsync(SetTargetForwardingRuleRequest request)

Changes target URL for forwarding rule. 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   SetTargetForwardingRuleRequest request =
       SetTargetForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetReferenceResource(TargetReference.newBuilder().build())
           .build();
   Operation response = forwardingRulesClient.setTargetAsync(request).get();
 }
 

Parameter
Name	Description
request	SetTargetForwardingRuleRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

setTargetAsync(String project, String region, String forwardingRule, TargetReference targetReferenceResource)

public final OperationFuture<Operation,Operation> setTargetAsync(String project, String region, String forwardingRule, TargetReference targetReferenceResource)

Changes target URL for forwarding rule. 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String forwardingRule = "forwardingRule-1429104743";
   TargetReference targetReferenceResource = TargetReference.newBuilder().build();
   Operation response =
       forwardingRulesClient
           .setTargetAsync(project, region, forwardingRule, targetReferenceResource)
           .get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
forwardingRule	String Name of the ForwardingRule resource in which target is to be set.
targetReferenceResource	TargetReference The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

setTargetCallable()

public final UnaryCallable<SetTargetForwardingRuleRequest,Operation> setTargetCallable()

Changes target URL for forwarding rule. 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   SetTargetForwardingRuleRequest request =
       SetTargetForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetReferenceResource(TargetReference.newBuilder().build())
           .build();
   ApiFuture<Operation> future = forwardingRulesClient.setTargetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<SetTargetForwardingRuleRequest,Operation>

setTargetOperationCallable()

public final OperationCallable<SetTargetForwardingRuleRequest,Operation,Operation> setTargetOperationCallable()

Changes target URL for forwarding rule. 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
   SetTargetForwardingRuleRequest request =
       SetTargetForwardingRuleRequest.newBuilder()
           .setForwardingRule("forwardingRule-1429104743")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setTargetReferenceResource(TargetReference.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       forwardingRulesClient.setTargetOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<SetTargetForwardingRuleRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()