IPForwardingRule (Apache jclouds 1.7.3 API)

java.lang.Object
- org.jclouds.cloudstack.domain.IPForwardingRule

All Implemented Interfaces:

Comparable<IPForwardingRule>
```
public class IPForwardingRule
extends Object
implements Comparable<IPForwardingRule>
```
Class IPForwardingRule

Author:

Adrian Cole

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IPForwardingRule.Builder<T extends IPForwardingRule.Builder<T>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`IPForwardingRule.Builder<T extends IPForwardingRule.Builder<T>>`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`IPForwardingRule(String id, String IPAddress, String IPAddressId, int startPort, String protocol, int endPort, String state, String virtualMachineDisplayName, String virtualMachineId, String virtualMachineName, int publicPort, Set<String> CIDRs, int privateEndPort, int publicEndPort)`

Method Summary

Methods
Modifier and Type	Method and Description
`static IPForwardingRule.Builder<?>`	`builder()`
`int`	`compareTo(IPForwardingRule o)`
`boolean`	`equals(Object obj)`
`Set<String>`	`getCIDRs()`
`int`	`getEndPort()`
`String`	`getId()`
`String`	`getIPAddress()`
`String`	`getIPAddressId()`
`int`	`getPrivateEndPort()`
`String`	`getProtocol()`
`int`	`getPublicEndPort()`
`int`	`getPublicPort()`
`int`	`getStartPort()`
`String`	`getState()`
`String`	`getVirtualMachineDisplayName()`
`String`	`getVirtualMachineId()`
`String`	`getVirtualMachineName()`
`int`	`hashCode()`
`protected com.google.common.base.Objects.ToStringHelper`	`string()`
`IPForwardingRule.Builder<?>`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPForwardingRule

@ConstructorProperties(value={"id","ipaddress","ipaddressid","startport","protocol","endport","state","virtualmachinedisplayname","virtualmachineid","virtualmachinename","publicport","cidrlist","privateendport","publicendport"})
protected IPForwardingRule(String id,
                                           String IPAddress,
                                           String IPAddressId,
                                           int startPort,
                                           @Nullable
                                           String protocol,
                                           int endPort,
                                           @Nullable
                                           String state,
                                           @Nullable
                                           String virtualMachineDisplayName,
                                           @Nullable
                                           String virtualMachineId,
                                           @Nullable
                                           String virtualMachineName,
                                           int publicPort,
                                           @Nullable
                                           Set<String> CIDRs,
                                           int privateEndPort,
                                           int publicEndPort)

Method Detail
- builder
```
public static IPForwardingRule.Builder<?> builder()
```
- toBuilder
```
public IPForwardingRule.Builder<?> toBuilder()
```
- getId
```
public String getId()
```
  Returns:
  the ID of the ip forwarding rule
- getIPAddress
```
@Nullable
public String getIPAddress()
```
  Returns:
  the public ip address for the ip forwarding rule
- getIPAddressId
```
@Nullable
public String getIPAddressId()
```
  Returns:
  the public ip address id for the ip forwarding rule
- getStartPort
```
public int getStartPort()
```
  Returns:
  the private port for the ip forwarding rule
- getProtocol
```
@Nullable
public String getProtocol()
```
  Returns:
  the protocol of the ip forwarding rule
- getEndPort
```
public int getEndPort()
```
  Returns:
  the public port for the ip forwarding rule
- getState
```
@Nullable
public String getState()
```
  Returns:
  the state of the rule
- getVirtualMachineDisplayName
```
@Nullable
public String getVirtualMachineDisplayName()
```
  Returns:
  the VM display name for the ip forwarding rule
- getVirtualMachineId
```
@Nullable
public String getVirtualMachineId()
```
  Returns:
  the VM ID for the ip forwarding rule
- getVirtualMachineName
```
@Nullable
public String getVirtualMachineName()
```
  Returns:
  the VM name for the ip forwarding rule
- getPublicPort
```
public int getPublicPort()
```
  Returns:
  the starting port of port forwarding rule's public port range
- getCIDRs
```
public Set<String> getCIDRs()
```
  Returns:
  the cidr list to forward traffic from
- getPrivateEndPort
```
public int getPrivateEndPort()
```
  Returns:
  the ending port of port forwarding rule's private port range
- getPublicEndPort
```
public int getPublicEndPort()
```
  Returns:
  the ending port of port forwarding rule's private port range
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- string
```
protected com.google.common.base.Objects.ToStringHelper string()
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- compareTo
```
public int compareTo(IPForwardingRule o)
```
  Specified by:
  
  compareTo in interface Comparable<IPForwardingRule>

Class IPForwardingRule

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IPForwardingRule

Method Detail

builder

toBuilder

getId

getIPAddress

getIPAddressId

getStartPort

getProtocol

getEndPort

getState

getVirtualMachineDisplayName

getVirtualMachineId

getVirtualMachineName

getPublicPort

getCIDRs

getPrivateEndPort

getPublicEndPort

hashCode

equals

string

toString

compareTo