Class GlobalForwardingRulesClient (1.15.0)

Version 1.15.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 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 GlobalForwardingRulesClient implements 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().

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 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.

Inheritance

java.lang.Object > GlobalForwardingRulesClient

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 GlobalForwardingRulesClient create()

Constructs an instance of GlobalForwardingRulesClient with default settings.

Returns

Type	Description
GlobalForwardingRulesClient

Exceptions

Type	Description
IOException

create(GlobalForwardingRulesSettings settings)

public static final GlobalForwardingRulesClient create(GlobalForwardingRulesSettings settings)

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.

Parameter

Name	Description
settings	GlobalForwardingRulesSettings

Returns

Type	Description
GlobalForwardingRulesClient

Exceptions

Type	Description
IOException

create(GlobalForwardingRulesStub stub)

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).

Parameter

Name	Description
stub	GlobalForwardingRulesStub

Returns

Type	Description
GlobalForwardingRulesClient

Constructors

GlobalForwardingRulesClient(GlobalForwardingRulesSettings settings)

protected GlobalForwardingRulesClient(GlobalForwardingRulesSettings settings)

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.

Parameter

Name	Description
settings	GlobalForwardingRulesSettings

GlobalForwardingRulesClient(GlobalForwardingRulesStub stub)

protected GlobalForwardingRulesClient(GlobalForwardingRulesStub stub)

Parameter

Name	Description
stub	GlobalForwardingRulesStub

Methods

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(DeleteGlobalForwardingRuleRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String forwardingRule)

public final 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

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final 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();
 }
 

Returns

Type	Description
UnaryCallable<DeleteGlobalForwardingRuleRequest,Operation>

deleteOperationCallable()

public final 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();
 }
 

Returns

Type	Description
OperationCallable<DeleteGlobalForwardingRuleRequest,Operation,Operation>

get(GetGlobalForwardingRuleRequest request)

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);
 }
 

Parameter

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

Returns

Type	Description
ForwardingRule

get(String project, String forwardingRule)

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

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

Returns

Type	Description
ForwardingRule

getCallable()

public final 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();
 }
 

Returns

Type	Description
UnaryCallable<GetGlobalForwardingRuleRequest,ForwardingRule>

getSettings()

public final GlobalForwardingRulesSettings getSettings()

Returns

Type	Description
GlobalForwardingRulesSettings

getStub()

public GlobalForwardingRulesStub getStub()

Returns

Type	Description
GlobalForwardingRulesStub

insertAsync(InsertGlobalForwardingRuleRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, ForwardingRule forwardingRuleResource)

public final 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

Name	Description
project	String Project ID for this request.
forwardingRuleResource	ForwardingRule The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final 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();
 }
 

Returns

Type	Description
UnaryCallable<InsertGlobalForwardingRuleRequest,Operation>

insertOperationCallable()

public final 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();
 }
 

Returns

Type	Description
OperationCallable<InsertGlobalForwardingRuleRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListGlobalForwardingRulesRequest request)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
GlobalForwardingRulesClient.ListPagedResponse

list(String project)

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);
   }
 }
 

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
GlobalForwardingRulesClient.ListPagedResponse

listCallable()

public final 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListGlobalForwardingRulesRequest,ForwardingRuleList>

listPagedCallable()

public final 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);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListGlobalForwardingRulesRequest,ListPagedResponse>

patchAsync(PatchGlobalForwardingRuleRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchGlobalForwardingRuleRequest 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 (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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String forwardingRule, ForwardingRule forwardingRuleResource)

public final 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

Name	Description
project	String Project ID for 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<PatchGlobalForwardingRuleRequest,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 (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();
 }
 

Returns

Type	Description
UnaryCallable<PatchGlobalForwardingRuleRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchGlobalForwardingRuleRequest,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 (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();
 }
 

Returns

Type	Description
OperationCallable<PatchGlobalForwardingRuleRequest,Operation,Operation>

setLabelsAsync(SetLabelsGlobalForwardingRuleRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)

public final 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

Name	Description
project	String Project ID for this request.
resource	String Name or id of the resource for this request.
globalSetLabelsRequestResource	GlobalSetLabelsRequest The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

setLabelsCallable()

public final 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();
 }
 

Returns

Type	Description
UnaryCallable<SetLabelsGlobalForwardingRuleRequest,Operation>

setLabelsOperationCallable()

public final 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();
 }
 

Returns

Type	Description
OperationCallable<SetLabelsGlobalForwardingRuleRequest,Operation,Operation>

setTargetAsync(SetTargetGlobalForwardingRuleRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

setTargetAsync(String project, String forwardingRule, TargetReference targetReferenceResource)

public final 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

Name	Description
project	String Project ID for 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<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();
 }
 

Returns

Type	Description
UnaryCallable<SetTargetGlobalForwardingRuleRequest,Operation>

setTargetOperationCallable()

public final 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();
 }
 

Returns

Type	Description
OperationCallable<SetTargetGlobalForwardingRuleRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()