com.google.api.services.compute.model

Class ForwardingRule

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.ForwardingRule

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class ForwardingRule
extends com.google.api.client.json.GenericJson

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.

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

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ForwardingRule()

Method Summary

Methods

Modifier and Type	Method and Description
ForwardingRule	clone()
java.lang.String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
java.lang.String	getDescription() An optional description of this resource.
java.math.BigInteger	getId() [Output Only] The unique identifier for the resource.
java.lang.String	getIPAddress() Value of the reserved IP address that this forwarding rule is serving on behalf of.
java.lang.String	getIPProtocol() The IP protocol to which this rule applies.
java.lang.String	getKind() [Output Only] Type of the resource.
java.lang.String	getName() Name of the resource; provided by the client when the resource is created.
java.lang.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.
java.lang.String	getRegion() [Output Only] URL of the region where the regional forwarding rule resides.
java.lang.String	getSelfLink() [Output Only] Server-defined URL for the resource.
java.lang.String	getTarget() The URL of the target resource to receive the matched traffic.
ForwardingRule	set(java.lang.String fieldName, java.lang.Object value)
ForwardingRule	setCreationTimestamp(java.lang.String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
ForwardingRule	setDescription(java.lang.String description) An optional description of this resource.
ForwardingRule	setId(java.math.BigInteger id) [Output Only] The unique identifier for the resource.
ForwardingRule	setIPAddress(java.lang.String iPAddress) Value of the reserved IP address that this forwarding rule is serving on behalf of.
ForwardingRule	setIPProtocol(java.lang.String iPProtocol) The IP protocol to which this rule applies.
ForwardingRule	setKind(java.lang.String kind) [Output Only] Type of the resource.
ForwardingRule	setName(java.lang.String name) Name of the resource; provided by the client when the resource is created.
ForwardingRule	setPortRange(java.lang.String portRange) Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target.
ForwardingRule	setRegion(java.lang.String region) [Output Only] URL of the region where the regional forwarding rule resides.
ForwardingRule	setSelfLink(java.lang.String selfLink) [Output Only] Server-defined URL for the resource.
ForwardingRule	setTarget(java.lang.String target) The URL of the target resource to receive the matched traffic.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ForwardingRule

public ForwardingRule()

Method Detail

getIPAddress

public java.lang.String getIPAddress()

Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned.

Returns:

value or null for none

setIPAddress

public ForwardingRule setIPAddress(java.lang.String iPAddress)

Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned.

Parameters:

iPAddress - iPAddress or null for none

getIPProtocol

public java.lang.String getIPProtocol()

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

Returns:

value or null for none

setIPProtocol

public ForwardingRule setIPProtocol(java.lang.String iPProtocol)

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

Parameters:

iPProtocol - iPProtocol or null for none

getCreationTimestamp

public java.lang.String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public ForwardingRule setCreationTimestamp(java.lang.String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp or null for none

getDescription

public java.lang.String getDescription()

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

Returns:

value or null for none

setDescription

public ForwardingRule setDescription(java.lang.String description)

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

Parameters:

description - description or null for none

getId

public java.math.BigInteger getId()

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

Returns:

value or null for none

setId

public ForwardingRule setId(java.math.BigInteger id)

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

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

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

Returns:

value or null for none

setKind

public ForwardingRule setKind(java.lang.String kind)

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

Parameters:

kind - kind or null for none

getName

public java.lang.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.

Returns:

value or null for none

setName

public ForwardingRule setName(java.lang.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.

Parameters:

name - name or null for none

getPortRange

public java.lang.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.

Returns:

value or null for none

setPortRange

public ForwardingRule setPortRange(java.lang.String portRange)

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.

Parameters:

portRange - portRange or null for none

getRegion

public java.lang.String getRegion()

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.

Returns:

value or null for none

setRegion

public ForwardingRule setRegion(java.lang.String region)

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.

Parameters:

region - region or null for none

getSelfLink

public java.lang.String getSelfLink()

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

Returns:

value or null for none

setSelfLink

public ForwardingRule setSelfLink(java.lang.String selfLink)

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

Parameters:

selfLink - selfLink or null for none

getTarget

public java.lang.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 TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.

Returns:

value or null for none

setTarget

public ForwardingRule setTarget(java.lang.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 TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.

Parameters:

target - target or null for none

set

public ForwardingRule set(java.lang.String fieldName,
                 java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ForwardingRule clone()

Overrides:

clone in class com.google.api.client.json.GenericJson