com.google.cloud.compute.v1

Class GlobalForwardingRuleClient

java.lang.Object

com.google.cloud.compute.v1.GlobalForwardingRuleClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: Creates and runs virtual machines on Google Cloud Platform.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectGlobalForwardingRuleName forwardingRule = ProjectGlobalForwardingRuleName.of("[PROJECT]", "[FORWARDING_RULE]");
   Operation response = globalForwardingRuleClient.deleteGlobalForwardingRule(forwardingRule);
 }
 
 

Note: close() needs to be called on the globalForwardingRuleClient 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 GlobalForwardingRuleSettings to create(). For example:

To customize credentials:

 
 GlobalForwardingRuleSettings globalForwardingRuleSettings =
     GlobalForwardingRuleSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GlobalForwardingRuleClient globalForwardingRuleClient =
     GlobalForwardingRuleClient.create(globalForwardingRuleSettings);
 
 

To customize the endpoint:

 
 GlobalForwardingRuleSettings globalForwardingRuleSettings =
     GlobalForwardingRuleSettings.newBuilder().setEndpoint(myEndpoint).build();
 GlobalForwardingRuleClient globalForwardingRuleClient =
     GlobalForwardingRuleClient.create(globalForwardingRuleSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalForwardingRuleClient.ListGlobalForwardingRulesFixedSizeCollection
static class	GlobalForwardingRuleClient.ListGlobalForwardingRulesPage
static class	GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GlobalForwardingRuleClient(GlobalForwardingRuleSettings settings) Constructs an instance of GlobalForwardingRuleClient, using the given settings.
protected	GlobalForwardingRuleClient(GlobalForwardingRuleStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static GlobalForwardingRuleClient	create() Constructs an instance of GlobalForwardingRuleClient with default settings.
static GlobalForwardingRuleClient	create(GlobalForwardingRuleSettings settings) Constructs an instance of GlobalForwardingRuleClient, using the given settings.
static GlobalForwardingRuleClient	create(GlobalForwardingRuleStub stub) Constructs an instance of GlobalForwardingRuleClient, using the given stub for making calls.
Operation	deleteGlobalForwardingRule(DeleteGlobalForwardingRuleHttpRequest request) Deletes the specified GlobalForwardingRule resource.
Operation	deleteGlobalForwardingRule(ProjectGlobalForwardingRuleName forwardingRule) Deletes the specified GlobalForwardingRule resource.
Operation	deleteGlobalForwardingRule(String forwardingRule) Deletes the specified GlobalForwardingRule resource.
com.google.api.gax.rpc.UnaryCallable<DeleteGlobalForwardingRuleHttpRequest,Operation>	deleteGlobalForwardingRuleCallable() Deletes the specified GlobalForwardingRule resource.
ForwardingRule	getGlobalForwardingRule(GetGlobalForwardingRuleHttpRequest request) Returns the specified GlobalForwardingRule resource.
ForwardingRule	getGlobalForwardingRule(ProjectGlobalForwardingRuleName forwardingRule) Returns the specified GlobalForwardingRule resource.
ForwardingRule	getGlobalForwardingRule(String forwardingRule) Returns the specified GlobalForwardingRule resource.
com.google.api.gax.rpc.UnaryCallable<GetGlobalForwardingRuleHttpRequest,ForwardingRule>	getGlobalForwardingRuleCallable() Returns the specified GlobalForwardingRule resource.
GlobalForwardingRuleSettings	getSettings()
GlobalForwardingRuleStub	getStub()
Operation	insertGlobalForwardingRule(InsertGlobalForwardingRuleHttpRequest request) Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
Operation	insertGlobalForwardingRule(ProjectName project, ForwardingRule forwardingRuleResource) Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
Operation	insertGlobalForwardingRule(String project, ForwardingRule forwardingRuleResource) Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertGlobalForwardingRuleHttpRequest,Operation>	insertGlobalForwardingRuleCallable() Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse	listGlobalForwardingRules(ListGlobalForwardingRulesHttpRequest request) Retrieves a list of GlobalForwardingRule resources available to the specified project.
GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse	listGlobalForwardingRules(ProjectName project) Retrieves a list of GlobalForwardingRule resources available to the specified project.
GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse	listGlobalForwardingRules(String project) Retrieves a list of GlobalForwardingRule resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListGlobalForwardingRulesHttpRequest,ForwardingRuleList>	listGlobalForwardingRulesCallable() Retrieves a list of GlobalForwardingRule resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListGlobalForwardingRulesHttpRequest,GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse>	listGlobalForwardingRulesPagedCallable() Retrieves a list of GlobalForwardingRule resources available to the specified project.
Operation	setTargetGlobalForwardingRule(ProjectGlobalForwardingRuleName forwardingRule, TargetReference targetReferenceResource) Changes target URL for the GlobalForwardingRule resource.
Operation	setTargetGlobalForwardingRule(SetTargetGlobalForwardingRuleHttpRequest request) Changes target URL for the GlobalForwardingRule resource.
Operation	setTargetGlobalForwardingRule(String forwardingRule, TargetReference targetReferenceResource) Changes target URL for the GlobalForwardingRule resource.
com.google.api.gax.rpc.UnaryCallable<SetTargetGlobalForwardingRuleHttpRequest,Operation>	setTargetGlobalForwardingRuleCallable() Changes target URL for the GlobalForwardingRule resource.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GlobalForwardingRuleClient

protected GlobalForwardingRuleClient(GlobalForwardingRuleSettings settings)
                              throws IOException

Constructs an instance of GlobalForwardingRuleClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

GlobalForwardingRuleClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected GlobalForwardingRuleClient(GlobalForwardingRuleStub stub)

Method Detail

create

public static final GlobalForwardingRuleClient create()
                                               throws IOException

Constructs an instance of GlobalForwardingRuleClient with default settings.

Throws:

IOException

create

public static final GlobalForwardingRuleClient create(GlobalForwardingRuleSettings settings)
                                               throws IOException

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

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final GlobalForwardingRuleClient create(GlobalForwardingRuleStub stub)

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

getSettings

public final GlobalForwardingRuleSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public GlobalForwardingRuleStub getStub()

deleteGlobalForwardingRule

@BetaApi
public final Operation deleteGlobalForwardingRule(ProjectGlobalForwardingRuleName forwardingRule)

Deletes the specified GlobalForwardingRule resource.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectGlobalForwardingRuleName forwardingRule = ProjectGlobalForwardingRuleName.of("[PROJECT]", "[FORWARDING_RULE]");
   Operation response = globalForwardingRuleClient.deleteGlobalForwardingRule(forwardingRule);
 }
 

Parameters:

forwardingRule - Name of the ForwardingRule resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGlobalForwardingRule

@BetaApi
public final Operation deleteGlobalForwardingRule(String forwardingRule)

Deletes the specified GlobalForwardingRule resource.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectGlobalForwardingRuleName forwardingRule = ProjectGlobalForwardingRuleName.of("[PROJECT]", "[FORWARDING_RULE]");
   Operation response = globalForwardingRuleClient.deleteGlobalForwardingRule(forwardingRule.toString());
 }
 

Parameters:

forwardingRule - Name of the ForwardingRule resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGlobalForwardingRule

@BetaApi
public final Operation deleteGlobalForwardingRule(DeleteGlobalForwardingRuleHttpRequest request)

Deletes the specified GlobalForwardingRule resource.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedForwardingRule = ProjectGlobalForwardingRuleName.format("[PROJECT]", "[FORWARDING_RULE]");
   DeleteGlobalForwardingRuleHttpRequest request = DeleteGlobalForwardingRuleHttpRequest.newBuilder()
     .setForwardingRule(formattedForwardingRule)
     .build();
   Operation response = globalForwardingRuleClient.deleteGlobalForwardingRule(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGlobalForwardingRuleCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteGlobalForwardingRuleHttpRequest,Operation> deleteGlobalForwardingRuleCallable()

Deletes the specified GlobalForwardingRule resource.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedForwardingRule = ProjectGlobalForwardingRuleName.format("[PROJECT]", "[FORWARDING_RULE]");
   DeleteGlobalForwardingRuleHttpRequest request = DeleteGlobalForwardingRuleHttpRequest.newBuilder()
     .setForwardingRule(formattedForwardingRule)
     .build();
   ApiFuture<Operation> future = globalForwardingRuleClient.deleteGlobalForwardingRuleCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getGlobalForwardingRule

@BetaApi
public final ForwardingRule getGlobalForwardingRule(ProjectGlobalForwardingRuleName forwardingRule)

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectGlobalForwardingRuleName forwardingRule = ProjectGlobalForwardingRuleName.of("[PROJECT]", "[FORWARDING_RULE]");
   ForwardingRule response = globalForwardingRuleClient.getGlobalForwardingRule(forwardingRule);
 }
 

Parameters:

forwardingRule - Name of the ForwardingRule resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGlobalForwardingRule

@BetaApi
public final ForwardingRule getGlobalForwardingRule(String forwardingRule)

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectGlobalForwardingRuleName forwardingRule = ProjectGlobalForwardingRuleName.of("[PROJECT]", "[FORWARDING_RULE]");
   ForwardingRule response = globalForwardingRuleClient.getGlobalForwardingRule(forwardingRule.toString());
 }
 

Parameters:

forwardingRule - Name of the ForwardingRule resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGlobalForwardingRule

@BetaApi
public final ForwardingRule getGlobalForwardingRule(GetGlobalForwardingRuleHttpRequest request)

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedForwardingRule = ProjectGlobalForwardingRuleName.format("[PROJECT]", "[FORWARDING_RULE]");
   GetGlobalForwardingRuleHttpRequest request = GetGlobalForwardingRuleHttpRequest.newBuilder()
     .setForwardingRule(formattedForwardingRule)
     .build();
   ForwardingRule response = globalForwardingRuleClient.getGlobalForwardingRule(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGlobalForwardingRuleCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetGlobalForwardingRuleHttpRequest,ForwardingRule> getGlobalForwardingRuleCallable()

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedForwardingRule = ProjectGlobalForwardingRuleName.format("[PROJECT]", "[FORWARDING_RULE]");
   GetGlobalForwardingRuleHttpRequest request = GetGlobalForwardingRuleHttpRequest.newBuilder()
     .setForwardingRule(formattedForwardingRule)
     .build();
   ApiFuture<ForwardingRule> future = globalForwardingRuleClient.getGlobalForwardingRuleCallable().futureCall(request);
   // Do something
   ForwardingRule response = future.get();
 }
 

insertGlobalForwardingRule

@BetaApi
public final Operation insertGlobalForwardingRule(ProjectName project,
                                                           ForwardingRule forwardingRuleResource)

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
   Operation response = globalForwardingRuleClient.insertGlobalForwardingRule(project, forwardingRuleResource);
 }
 

Parameters:

project - Project ID for this request.

forwardingRuleResource - Represents a Forwarding Rule resource.

A forwardingRules resource represents a regional forwarding rule.

Regional external forwarding rules can reference any of the following resources:

- A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier.

Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer.

For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy.

For more information, read Using Forwarding rules.

A globalForwardingRules resource represents a global forwarding rule.

Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertGlobalForwardingRule

@BetaApi
public final Operation insertGlobalForwardingRule(String project,
                                                           ForwardingRule forwardingRuleResource)

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
   Operation response = globalForwardingRuleClient.insertGlobalForwardingRule(project.toString(), forwardingRuleResource);
 }
 

Parameters:

project - Project ID for this request.

forwardingRuleResource - Represents a Forwarding Rule resource.

A forwardingRules resource represents a regional forwarding rule.

Regional external forwarding rules can reference any of the following resources:

- A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier.

Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer.

For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy.

For more information, read Using Forwarding rules.

A globalForwardingRules resource represents a global forwarding rule.

Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertGlobalForwardingRule

@BetaApi
public final Operation insertGlobalForwardingRule(InsertGlobalForwardingRuleHttpRequest request)

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
   InsertGlobalForwardingRuleHttpRequest request = InsertGlobalForwardingRuleHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setForwardingRuleResource(forwardingRuleResource)
     .build();
   Operation response = globalForwardingRuleClient.insertGlobalForwardingRule(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertGlobalForwardingRuleCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertGlobalForwardingRuleHttpRequest,Operation> insertGlobalForwardingRuleCallable()

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
   InsertGlobalForwardingRuleHttpRequest request = InsertGlobalForwardingRuleHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setForwardingRuleResource(forwardingRuleResource)
     .build();
   ApiFuture<Operation> future = globalForwardingRuleClient.insertGlobalForwardingRuleCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listGlobalForwardingRules

@BetaApi
public final GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse listGlobalForwardingRules(ProjectName project)

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

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (ForwardingRule element : globalForwardingRuleClient.listGlobalForwardingRules(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGlobalForwardingRules

@BetaApi
public final GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse listGlobalForwardingRules(String project)

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

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (ForwardingRule element : globalForwardingRuleClient.listGlobalForwardingRules(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGlobalForwardingRules

@BetaApi
public final GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse listGlobalForwardingRules(ListGlobalForwardingRulesHttpRequest request)

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

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListGlobalForwardingRulesHttpRequest request = ListGlobalForwardingRulesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (ForwardingRule element : globalForwardingRuleClient.listGlobalForwardingRules(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGlobalForwardingRulesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListGlobalForwardingRulesHttpRequest,GlobalForwardingRuleClient.ListGlobalForwardingRulesPagedResponse> listGlobalForwardingRulesPagedCallable()

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

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListGlobalForwardingRulesHttpRequest request = ListGlobalForwardingRulesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListGlobalForwardingRulesPagedResponse> future = globalForwardingRuleClient.listGlobalForwardingRulesPagedCallable().futureCall(request);
   // Do something
   for (ForwardingRule element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listGlobalForwardingRulesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListGlobalForwardingRulesHttpRequest,ForwardingRuleList> listGlobalForwardingRulesCallable()

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

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListGlobalForwardingRulesHttpRequest request = ListGlobalForwardingRulesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     ForwardingRuleList response = globalForwardingRuleClient.listGlobalForwardingRulesCallable().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;
     }
   }
 }
 

setTargetGlobalForwardingRule

@BetaApi
public final Operation setTargetGlobalForwardingRule(ProjectGlobalForwardingRuleName 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:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectGlobalForwardingRuleName forwardingRule = ProjectGlobalForwardingRuleName.of("[PROJECT]", "[FORWARDING_RULE]");
   TargetReference targetReferenceResource = TargetReference.newBuilder().build();
   Operation response = globalForwardingRuleClient.setTargetGlobalForwardingRule(forwardingRule, targetReferenceResource);
 }
 

Parameters:

forwardingRule - Name of the ForwardingRule resource in which target is to be set.

targetReferenceResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setTargetGlobalForwardingRule

@BetaApi
public final Operation setTargetGlobalForwardingRule(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:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   ProjectGlobalForwardingRuleName forwardingRule = ProjectGlobalForwardingRuleName.of("[PROJECT]", "[FORWARDING_RULE]");
   TargetReference targetReferenceResource = TargetReference.newBuilder().build();
   Operation response = globalForwardingRuleClient.setTargetGlobalForwardingRule(forwardingRule.toString(), targetReferenceResource);
 }
 

Parameters:

forwardingRule - Name of the ForwardingRule resource in which target is to be set.

targetReferenceResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setTargetGlobalForwardingRule

@BetaApi
public final Operation setTargetGlobalForwardingRule(SetTargetGlobalForwardingRuleHttpRequest request)

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

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedForwardingRule = ProjectGlobalForwardingRuleName.format("[PROJECT]", "[FORWARDING_RULE]");
   TargetReference targetReferenceResource = TargetReference.newBuilder().build();
   SetTargetGlobalForwardingRuleHttpRequest request = SetTargetGlobalForwardingRuleHttpRequest.newBuilder()
     .setForwardingRule(formattedForwardingRule)
     .setTargetReferenceResource(targetReferenceResource)
     .build();
   Operation response = globalForwardingRuleClient.setTargetGlobalForwardingRule(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setTargetGlobalForwardingRuleCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<SetTargetGlobalForwardingRuleHttpRequest,Operation> setTargetGlobalForwardingRuleCallable()

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

Sample code:

 try (GlobalForwardingRuleClient globalForwardingRuleClient = GlobalForwardingRuleClient.create()) {
   String formattedForwardingRule = ProjectGlobalForwardingRuleName.format("[PROJECT]", "[FORWARDING_RULE]");
   TargetReference targetReferenceResource = TargetReference.newBuilder().build();
   SetTargetGlobalForwardingRuleHttpRequest request = SetTargetGlobalForwardingRuleHttpRequest.newBuilder()
     .setForwardingRule(formattedForwardingRule)
     .setTargetReferenceResource(targetReferenceResource)
     .build();
   ApiFuture<Operation> future = globalForwardingRuleClient.setTargetGlobalForwardingRuleCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

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

isShutdown

public boolean isShutdown()

Specified by:

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

isTerminated

public boolean isTerminated()

Specified by:

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

shutdownNow

public void shutdownNow()

Specified by:

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

awaitTermination

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

Specified by:

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

Throws:

InterruptedException