@Generated(value="by GAPIC") @BetaApi public final class ForwardingRule extends Object implements ApiMessage
Modifier and Type | Class and Description |
---|---|
static class |
ForwardingRule.Builder |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
Boolean |
getAllPorts()
This field is used along with the backend_service field for internal load balancing or with the
target field for internal TargetInstance.
|
ApiMessage |
getApiMessageRequestBody() |
String |
getBackendService()
This field is only used for INTERNAL load balancing.
|
String |
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
static ForwardingRule |
getDefaultInstance() |
String |
getDescription()
An optional description of this resource.
|
List<String> |
getFieldMask() |
Object |
getFieldValue(String fieldName) |
String |
getId()
[Output Only] The unique identifier for the resource.
|
String |
getIPAddress()
The IP address that this forwarding rule is serving on behalf of.
|
String |
getIPProtocol()
The IP protocol to which this rule applies.
|
String |
getIpVersion()
The IP Version that will be used by this forwarding rule.
|
String |
getKind()
[Output Only] Type of the resource.
|
String |
getLoadBalancingScheme()
This signifies what the ForwardingRule will be used for and can only take the following values:
INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL.
|
String |
getName()
Name of the resource; provided by the client when the resource is created.
|
String |
getNetwork()
This field is not used for external load balancing.
|
String |
getNetworkTier()
This signifies the networking tier used for configuring this load balancer and can only take
the following values: PREMIUM , STANDARD.
|
String |
getPortRange()
This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
|
List<String> |
getPortsList()
This field is used along with the backend_service field for internal load balancing.
|
String |
getRegion()
[Output Only] URL of the region where the regional forwarding rule resides.
|
String |
getSelfLink()
[Output Only] Server-defined URL for the resource.
|
String |
getServiceLabel()
An optional prefix to the service name for this Forwarding Rule.
|
String |
getServiceName()
[Output Only] The internal fully qualified service name for this Forwarding Rule.
|
String |
getSubnetwork()
This field is only used for INTERNAL load balancing.
|
String |
getTarget()
The URL of the target resource to receive the matched traffic.
|
int |
hashCode() |
static ForwardingRule.Builder |
newBuilder() |
static ForwardingRule.Builder |
newBuilder(ForwardingRule prototype) |
ForwardingRule.Builder |
toBuilder() |
String |
toString() |
public Object getFieldValue(String fieldName)
getFieldValue
in interface ApiMessage
@Nullable public ApiMessage getApiMessageRequestBody()
getApiMessageRequestBody
in interface ApiMessage
@Nullable public List<String> getFieldMask()
getFieldMask
in interface ApiMessage
public Boolean getAllPorts()
When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule.
public String getBackendService()
For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
public String getCreationTimestamp()
public String getDescription()
public String getIPAddress()
Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional).
When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6.
When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL.
When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule.
An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: - 100.1.2.3 - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address - projects/project/regions/region/addresses/address - regions/region/addresses/address - global/addresses/address - address
public String getIPProtocol()
When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid.
public String getId()
public String getIpVersion()
public String getKind()
public String getLoadBalancingScheme()
public String getName()
public String getNetwork()
For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
public String getNetworkTier()
For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM.
If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.
public String getPortRange()
Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
Some types of forwarding target have constraints on the acceptable ports: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500
public List<String> getPortsList()
When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule.
You may specify a maximum of up to 5 ports.
public String getRegion()
public String getSelfLink()
public String getServiceLabel()
The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
This field is only used for internal load balancing.
public String getServiceName()
This field is only used for internal load balancing.
public String getSubnetwork()
For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
public String getTarget()
public static ForwardingRule.Builder newBuilder()
public static ForwardingRule.Builder newBuilder(ForwardingRule prototype)
public ForwardingRule.Builder toBuilder()
public static ForwardingRule getDefaultInstance()
Copyright © 2019 Google LLC. All rights reserved.