com.google.cloud.compute.v1

Class ForwardingRule.Builder

java.lang.Object

com.google.cloud.compute.v1.ForwardingRule.Builder

Enclosing class:

ForwardingRule

public static class ForwardingRule.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
ForwardingRule.Builder	addAllMetadataFilters(List<MetadataFilter> metadataFilters) Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients.
ForwardingRule.Builder	addAllPorts(List<String> ports) List of comma-separated ports.
ForwardingRule.Builder	addMetadataFilters(MetadataFilter metadataFilters) Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients.
ForwardingRule.Builder	addPorts(String ports) List of comma-separated ports.
ForwardingRule	build()
ForwardingRule.Builder	clone()
Boolean	getAllPorts() This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
String	getBackendService() This field is only used for INTERNAL load balancing.
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
String	getDescription() An optional description of this resource.
String	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.
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.
List<MetadataFilter>	getMetadataFiltersList() Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set 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 is deprecated.
List<String>	getPortsList() List of comma-separated ports.
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.
ForwardingRule.Builder	mergeFrom(ForwardingRule other)
ForwardingRule.Builder	setAllPorts(Boolean allPorts) This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
ForwardingRule.Builder	setBackendService(String backendService) This field is only used for INTERNAL load balancing.
ForwardingRule.Builder	setCreationTimestamp(String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
ForwardingRule.Builder	setDescription(String description) An optional description of this resource.
ForwardingRule.Builder	setId(String id) [Output Only] The unique identifier for the resource.
ForwardingRule.Builder	setIPAddress(String iPAddress) IP address that this forwarding rule serves.
ForwardingRule.Builder	setIPProtocol(String iPProtocol) The IP protocol to which this rule applies.
ForwardingRule.Builder	setIpVersion(String ipVersion) The IP Version that will be used by this forwarding rule.
ForwardingRule.Builder	setKind(String kind) [Output Only] Type of the resource.
ForwardingRule.Builder	setLoadBalancingScheme(String loadBalancingScheme) This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL.
ForwardingRule.Builder	setName(String name) Name of the resource; provided by the client when the resource is created.
ForwardingRule.Builder	setNetwork(String network) This field is not used for external load balancing.
ForwardingRule.Builder	setNetworkTier(String networkTier) This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD.
ForwardingRule.Builder	setPortRange(String portRange) This field is deprecated.
ForwardingRule.Builder	setRegion(String region) [Output Only] URL of the region where the regional forwarding rule resides.
ForwardingRule.Builder	setSelfLink(String selfLink) [Output Only] Server-defined URL for the resource.
ForwardingRule.Builder	setServiceLabel(String serviceLabel) An optional prefix to the service name for this Forwarding Rule.
ForwardingRule.Builder	setServiceName(String serviceName) [Output Only] The internal fully qualified service name for this Forwarding Rule.
ForwardingRule.Builder	setSubnetwork(String subnetwork) This field is only used for INTERNAL load balancing.
ForwardingRule.Builder	setTarget(String target) The URL of the target resource to receive the matched traffic.

Methods inherited from class java.lang.Object

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

Method Detail

mergeFrom

public ForwardingRule.Builder mergeFrom(ForwardingRule other)

getAllPorts

public Boolean getAllPorts()

This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields.

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.

setAllPorts

public ForwardingRule.Builder setAllPorts(Boolean allPorts)

This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields.

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.

getBackendService

public String getBackendService()

This field is only used for INTERNAL load balancing.

For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.

setBackendService

public ForwardingRule.Builder setBackendService(String backendService)

This field is only used for INTERNAL load balancing.

For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.

getCreationTimestamp

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

setCreationTimestamp

public ForwardingRule.Builder setCreationTimestamp(String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 text format.

getDescription

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

setDescription

public ForwardingRule.Builder setDescription(String description)

An optional description of this resource. Provide this property when you create the resource.

getIPAddress

public String getIPAddress()

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.

If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:

* IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: * projects/project_id/regions/region/addresses/address-name * regions/region/addresses/address-name * global/addresses/address-name * address-name

The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).

setIPAddress

public ForwardingRule.Builder setIPAddress(String iPAddress)

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.

If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:

* IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: * projects/project_id/regions/region/addresses/address-name * regions/region/addresses/address-name * global/addresses/address-name * address-name

The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).

getIPProtocol

public String getIPProtocol()

The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.

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.

setIPProtocol

public ForwardingRule.Builder setIPProtocol(String iPProtocol)

The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.

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.

getId

public String getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

setId

public ForwardingRule.Builder setId(String id)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

getIpVersion

public String getIpVersion()

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule.

setIpVersion

public ForwardingRule.Builder setIpVersion(String ipVersion)

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule.

getKind

public String getKind()

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.

setKind

public ForwardingRule.Builder setKind(String kind)

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.

getLoadBalancingScheme

public String getLoadBalancingScheme()

This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)

setLoadBalancingScheme

public ForwardingRule.Builder setLoadBalancingScheme(String loadBalancingScheme)

This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)

getMetadataFiltersList

public List<MetadataFilter> getMetadataFiltersList()

Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

addAllMetadataFilters

public ForwardingRule.Builder addAllMetadataFilters(List<MetadataFilter> metadataFilters)

Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

addMetadataFilters

public ForwardingRule.Builder addMetadataFilters(MetadataFilter metadataFilters)

Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

getName

public String getName()

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name 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.

setName

public ForwardingRule.Builder setName(String name)

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name 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.

getNetwork

public String getNetwork()

This field is not used for external load balancing.

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.

setNetwork

public ForwardingRule.Builder setNetwork(String network)

This field is not used for external load balancing.

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.

getNetworkTier

public String getNetworkTier()

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD.

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.

setNetworkTier

public ForwardingRule.Builder setNetworkTier(String networkTier)

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD.

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.

getPortRange

public String getPortRange()

This field is deprecated. See the port field.

setPortRange

public ForwardingRule.Builder setPortRange(String portRange)

This field is deprecated. See the port field.

getPortsList

public List<String> getPortsList()

List of comma-separated ports. The forwarding rule forwards packets with matching destination ports. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target pool, specifying ports is optional. You can specify an unlimited number of ports, but they must be contiguous. If you omit ports, GCP forwards traffic on any port of the forwarding rule's protocol.

If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target HTTP proxy, target HTTPS proxy, target TCP proxy, target SSL proxy, or target VPN gateway, you must specify ports using the following constraints:

- 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

If the forwarding rule's loadBalancingScheme is INTERNAL, you must specify ports in one of the following ways:

* A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol.

The ports field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.

Applicable only when IPProtocol is TCP, UDP, or SCTP. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.

addAllPorts

public ForwardingRule.Builder addAllPorts(List<String> ports)

List of comma-separated ports. The forwarding rule forwards packets with matching destination ports. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target pool, specifying ports is optional. You can specify an unlimited number of ports, but they must be contiguous. If you omit ports, GCP forwards traffic on any port of the forwarding rule's protocol.

If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target HTTP proxy, target HTTPS proxy, target TCP proxy, target SSL proxy, or target VPN gateway, you must specify ports using the following constraints:

- 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

If the forwarding rule's loadBalancingScheme is INTERNAL, you must specify ports in one of the following ways:

* A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol.

The ports field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.

Applicable only when IPProtocol is TCP, UDP, or SCTP. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.

addPorts

public ForwardingRule.Builder addPorts(String ports)

List of comma-separated ports. The forwarding rule forwards packets with matching destination ports. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target pool, specifying ports is optional. You can specify an unlimited number of ports, but they must be contiguous. If you omit ports, GCP forwards traffic on any port of the forwarding rule's protocol.

If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target HTTP proxy, target HTTPS proxy, target TCP proxy, target SSL proxy, or target VPN gateway, you must specify ports using the following constraints:

- 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

If the forwarding rule's loadBalancingScheme is INTERNAL, you must specify ports in one of the following ways:

* A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol.

The ports field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.

Applicable only when IPProtocol is TCP, UDP, or SCTP. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.

getRegion

public String getRegion()

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

setRegion

public ForwardingRule.Builder setRegion(String region)

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

getSelfLink

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

setSelfLink

public ForwardingRule.Builder setSelfLink(String selfLink)

[Output Only] Server-defined URL for the resource.

getServiceLabel

public String getServiceLabel()

An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name.

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.

setServiceLabel

public ForwardingRule.Builder setServiceLabel(String serviceLabel)

An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name.

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.

getServiceName

public String getServiceName()

[Output Only] The internal fully qualified service name for this Forwarding Rule.

This field is only used for internal load balancing.

setServiceName

public ForwardingRule.Builder setServiceName(String serviceName)

[Output Only] The internal fully qualified service name for this Forwarding Rule.

This field is only used for internal load balancing.

getSubnetwork

public String getSubnetwork()

This field is only used for INTERNAL load balancing.

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.

setSubnetwork

public ForwardingRule.Builder setSubnetwork(String subnetwork)

This field is only used for INTERNAL load balancing.

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.

getTarget

public String getTarget()

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid.

setTarget

public ForwardingRule.Builder setTarget(String target)

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid.

build

public ForwardingRule build()

clone

public ForwardingRule.Builder clone()

Overrides:

clone in class Object