public final class ForwardingRule extends GenericJson
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json
GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Constructor and Description |
---|
ForwardingRule() |
Modifier and Type | Method and Description |
---|---|
ForwardingRule |
clone() |
byte[] |
decodeFingerprint()
Fingerprint of this resource.
|
byte[] |
decodeLabelFingerprint()
A fingerprint for the labels being applied to this resource, which is essentially a hash of the
labels set used for optimistic locking.
|
ForwardingRule |
encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource.
|
ForwardingRule |
encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this resource, which is essentially a hash of the
labels set used for optimistic locking.
|
Boolean |
getAllowGlobalAccess()
This field is used along with the backend_service field for internal load balancing or with the
target field for internal TargetInstance.
|
Boolean |
getAllPorts()
This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or
Network Load Balancing, or with the target field for internal and external TargetInstance.
|
String |
getBackendService()
Identifies the backend service to which the forwarding rule sends traffic.
|
String |
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
String |
getDescription()
An optional description of this resource.
|
String |
getFingerprint()
Fingerprint of this resource.
|
BigInteger |
getId()
[Output Only] The unique identifier for the resource.
|
String |
getIPAddress()
IP address that this forwarding rule serves.
|
String |
getIPProtocol()
The IP protocol to which this rule applies.
|
String |
getIpVersion()
The IP Version that will be used by this forwarding rule.
|
Boolean |
getIsMirroringCollector()
Indicates whether or not this load balancer can be used as a collector for packet mirroring.
|
String |
getKind()
[Output Only] Type of the resource.
|
String |
getLabelFingerprint()
A fingerprint for the labels being applied to this resource, which is essentially a hash of the
labels set used for optimistic locking.
|
Map<String,String> |
getLabels()
Labels for this resource.
|
String |
getLoadBalancingScheme()
Specifies the forwarding rule type.
|
List<MetadataFilter> |
getMetadataFilters()
Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set
of xDS compliant clients.
|
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 can be used only if: - Load balancing scheme is one of EXTERNAL,
INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP.
|
List<String> |
getPorts()
The ports field is only supported when the forwarding rule references a backend_service
directly.
|
BigInteger |
getPscConnectionId()
[Output Only] The PSC connection id of the PSC Forwarding Rule.
|
String |
getPscConnectionStatus() |
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 |
getSelfLinkWithId()
[Output Only] Server-defined URL for this resource with the resource id.
|
List<ForwardingRuleServiceDirectoryRegistration> |
getServiceDirectoryRegistrations()
Service Directory resources to register this forwarding rule with.
|
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.
|
List<String> |
getSourceIpRanges()
If not empty, this Forwarding Rule will only forward the traffic when the source IP address
matches one of the IP addresses or CIDR ranges set here.
|
String |
getSubnetwork()
This field is only used for internal load balancing.
|
String |
getTarget() |
ForwardingRule |
set(String fieldName,
Object value) |
ForwardingRule |
setAllowGlobalAccess(Boolean allowGlobalAccess)
This field is used along with the backend_service field for internal load balancing or with the
target field for internal TargetInstance.
|
ForwardingRule |
setAllPorts(Boolean allPorts)
This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or
Network Load Balancing, or with the target field for internal and external TargetInstance.
|
ForwardingRule |
setBackendService(String backendService)
Identifies the backend service to which the forwarding rule sends traffic.
|
ForwardingRule |
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.
|
ForwardingRule |
setDescription(String description)
An optional description of this resource.
|
ForwardingRule |
setFingerprint(String fingerprint)
Fingerprint of this resource.
|
ForwardingRule |
setId(BigInteger id)
[Output Only] The unique identifier for the resource.
|
ForwardingRule |
setIPAddress(String iPAddress)
IP address that this forwarding rule serves.
|
ForwardingRule |
setIPProtocol(String iPProtocol)
The IP protocol to which this rule applies.
|
ForwardingRule |
setIpVersion(String ipVersion)
The IP Version that will be used by this forwarding rule.
|
ForwardingRule |
setIsMirroringCollector(Boolean isMirroringCollector)
Indicates whether or not this load balancer can be used as a collector for packet mirroring.
|
ForwardingRule |
setKind(String kind)
[Output Only] Type of the resource.
|
ForwardingRule |
setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this resource, which is essentially a hash of the
labels set used for optimistic locking.
|
ForwardingRule |
setLabels(Map<String,String> labels)
Labels for this resource.
|
ForwardingRule |
setLoadBalancingScheme(String loadBalancingScheme)
Specifies the forwarding rule type.
|
ForwardingRule |
setMetadataFilters(List<MetadataFilter> metadataFilters)
Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set
of xDS compliant clients.
|
ForwardingRule |
setName(String name)
Name of the resource; provided by the client when the resource is created.
|
ForwardingRule |
setNetwork(String network)
This field is not used for external load balancing.
|
ForwardingRule |
setNetworkTier(String networkTier)
This signifies the networking tier used for configuring this load balancer and can only take
the following values: PREMIUM, STANDARD.
|
ForwardingRule |
setPortRange(String portRange)
This field can be used only if: - Load balancing scheme is one of EXTERNAL,
INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP.
|
ForwardingRule |
setPorts(List<String> ports)
The ports field is only supported when the forwarding rule references a backend_service
directly.
|
ForwardingRule |
setPscConnectionId(BigInteger pscConnectionId)
[Output Only] The PSC connection id of the PSC Forwarding Rule.
|
ForwardingRule |
setPscConnectionStatus(String pscConnectionStatus) |
ForwardingRule |
setRegion(String region)
[Output Only] URL of the region where the regional forwarding rule resides.
|
ForwardingRule |
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.
|
ForwardingRule |
setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource with the resource id.
|
ForwardingRule |
setServiceDirectoryRegistrations(List<ForwardingRuleServiceDirectoryRegistration> serviceDirectoryRegistrations)
Service Directory resources to register this forwarding rule with.
|
ForwardingRule |
setServiceLabel(String serviceLabel)
An optional prefix to the service name for this Forwarding Rule.
|
ForwardingRule |
setServiceName(String serviceName)
[Output Only] The internal fully qualified service name for this Forwarding Rule.
|
ForwardingRule |
setSourceIpRanges(List<String> sourceIpRanges)
If not empty, this Forwarding Rule will only forward the traffic when the source IP address
matches one of the IP addresses or CIDR ranges set here.
|
ForwardingRule |
setSubnetwork(String subnetwork)
This field is only used for internal load balancing.
|
ForwardingRule |
setTarget(String target) |
getFactory, setFactory, toPrettyString, toString
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, isEmpty, keySet, size, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
public String getIPAddress()
null
for nonepublic ForwardingRule setIPAddress(String iPAddress)
iPAddress
- iPAddress or null
for nonepublic String getIPProtocol()
null
for nonepublic ForwardingRule setIPProtocol(String iPProtocol)
iPProtocol
- iPProtocol or null
for nonepublic Boolean getAllPorts()
null
for nonepublic ForwardingRule setAllPorts(Boolean allPorts)
allPorts
- allPorts or null
for nonepublic Boolean getAllowGlobalAccess()
null
for nonepublic ForwardingRule setAllowGlobalAccess(Boolean allowGlobalAccess)
allowGlobalAccess
- allowGlobalAccess or null
for nonepublic String getBackendService()
null
for nonepublic ForwardingRule setBackendService(String backendService)
backendService
- backendService or null
for nonepublic String getCreationTimestamp()
null
for nonepublic ForwardingRule setCreationTimestamp(String creationTimestamp)
creationTimestamp
- creationTimestamp or null
for nonepublic String getDescription()
null
for nonepublic ForwardingRule setDescription(String description)
description
- description or null
for nonepublic String getFingerprint()
null
for nonedecodeFingerprint()
public byte[] decodeFingerprint()
null
for nonegetFingerprint()
public ForwardingRule setFingerprint(String fingerprint)
fingerprint
- fingerprint or null
for none#encodeFingerprint()
public ForwardingRule encodeFingerprint(byte[] fingerprint)
The value is encoded Base64 or {@code null} for none.
public BigInteger getId()
null
for nonepublic ForwardingRule setId(BigInteger id)
id
- id or null
for nonepublic String getIpVersion()
null
for nonepublic ForwardingRule setIpVersion(String ipVersion)
ipVersion
- ipVersion or null
for nonepublic Boolean getIsMirroringCollector()
null
for nonepublic ForwardingRule setIsMirroringCollector(Boolean isMirroringCollector)
isMirroringCollector
- isMirroringCollector or null
for nonepublic String getKind()
null
for nonepublic ForwardingRule setKind(String kind)
kind
- kind or null
for nonepublic String getLabelFingerprint()
null
for nonedecodeLabelFingerprint()
public byte[] decodeLabelFingerprint()
null
for nonegetLabelFingerprint()
public ForwardingRule setLabelFingerprint(String labelFingerprint)
labelFingerprint
- labelFingerprint or null
for none#encodeLabelFingerprint()
public ForwardingRule encodeLabelFingerprint(byte[] labelFingerprint)
The value is encoded Base64 or {@code null} for none.
public Map<String,String> getLabels()
null
for nonepublic ForwardingRule setLabels(Map<String,String> labels)
labels
- labels or null
for nonepublic String getLoadBalancingScheme()
null
for nonepublic ForwardingRule setLoadBalancingScheme(String loadBalancingScheme)
loadBalancingScheme
- loadBalancingScheme or null
for nonepublic List<MetadataFilter> getMetadataFilters()
null
for nonepublic ForwardingRule setMetadataFilters(List<MetadataFilter> metadataFilters)
metadataFilters
- metadataFilters or null
for nonepublic String getName()
null
for nonepublic ForwardingRule setName(String name)
name
- name or null
for nonepublic String getNetwork()
null
for nonepublic ForwardingRule setNetwork(String network)
network
- network or null
for nonepublic String getNetworkTier()
null
for nonepublic ForwardingRule setNetworkTier(String networkTier)
networkTier
- networkTier or null
for nonepublic String getPortRange()
null
for nonepublic ForwardingRule setPortRange(String portRange)
portRange
- portRange or null
for nonepublic List<String> getPorts()
null
for nonepublic ForwardingRule setPorts(List<String> ports)
ports
- ports or null
for nonepublic BigInteger getPscConnectionId()
null
for nonepublic ForwardingRule setPscConnectionId(BigInteger pscConnectionId)
pscConnectionId
- pscConnectionId or null
for nonepublic String getPscConnectionStatus()
null
for nonepublic ForwardingRule setPscConnectionStatus(String pscConnectionStatus)
pscConnectionStatus
- pscConnectionStatus or null
for nonepublic String getRegion()
null
for nonepublic ForwardingRule setRegion(String region)
region
- region or null
for nonepublic String getSelfLink()
null
for nonepublic ForwardingRule setSelfLink(String selfLink)
selfLink
- selfLink or null
for nonepublic String getSelfLinkWithId()
null
for nonepublic ForwardingRule setSelfLinkWithId(String selfLinkWithId)
selfLinkWithId
- selfLinkWithId or null
for nonepublic List<ForwardingRuleServiceDirectoryRegistration> getServiceDirectoryRegistrations()
null
for nonepublic ForwardingRule setServiceDirectoryRegistrations(List<ForwardingRuleServiceDirectoryRegistration> serviceDirectoryRegistrations)
serviceDirectoryRegistrations
- serviceDirectoryRegistrations or null
for nonepublic String getServiceLabel()
null
for nonepublic ForwardingRule setServiceLabel(String serviceLabel)
serviceLabel
- serviceLabel or null
for nonepublic String getServiceName()
null
for nonepublic ForwardingRule setServiceName(String serviceName)
serviceName
- serviceName or null
for nonepublic List<String> getSourceIpRanges()
null
for nonepublic ForwardingRule setSourceIpRanges(List<String> sourceIpRanges)
sourceIpRanges
- sourceIpRanges or null
for nonepublic String getSubnetwork()
null
for nonepublic ForwardingRule setSubnetwork(String subnetwork)
subnetwork
- subnetwork or null
for nonepublic String getTarget()
null
for nonepublic ForwardingRule setTarget(String target)
target
- target or null
for nonepublic ForwardingRule set(String fieldName, Object value)
set
in class GenericJson
public ForwardingRule clone()
clone
in class GenericJson
Copyright © 2011–2021 Google. All rights reserved.