VmRule (Apache jclouds 1.8.1 API)

java.lang.Object
- org.jclouds.vcloud.domain.network.nat.rules.VmRule

All Implemented Interfaces:

NatRule
```
public class VmRule
extends Object
implements NatRule
```
The VmRule element describes a NAT rule that maps an IP address and port in a vApp network to an external IP address and port. The external IP address, external port, and internal port are specified in the element. The internal IP address is discovered by looking up the specified VmReference and VmNicId.

Since:

vcloud 0.9

Constructor Summary

Constructors
Constructor and Description
`VmRule(String externalIP, int externalPort, String vAppScopedLocalId, int vmNicId, int internalPort, NatProtocol protocol)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getExternalIP()` IP address to which this NAT rule maps the IP address specified in the vAppScopedLocalId element.
`Integer`	`getExternalPort()` network port to which this NAT rule maps the port number specified in the InternalPort element
`Integer`	`getInternalPort()` network port to which this NAT rule maps the port number specified in the ExternalPort element.
`NatProtocol`	`getProtocol()` specifies the network protocol to which this rule applies
`String`	`getVAppScopedLocalId()`
`int`	`getVmNicId()`
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - VmRule
```
public VmRule(@Nullable
      String externalIP,
      int externalPort,
      @Nullable
      String vAppScopedLocalId,
      int vmNicId,
      int internalPort,
      NatProtocol protocol)
```
- Method Detail
  - getExternalIP
```
@Nullable
public String getExternalIP()
```
    IP address to which this NAT rule maps the IP address specified in the vAppScopedLocalId element.
    
    Specified by:
    
    getExternalIP in interface NatRule
  - getExternalPort
```
public Integer getExternalPort()
```
    network port to which this NAT rule maps the port number specified in the InternalPort element
  - getVAppScopedLocalId
```
@Nullable
public String getVAppScopedLocalId()
```
    Returns:
    read‐only identifier created on import
    Since:
    
    vcloud 0.9
  - getVmNicId
```
public int getVmNicId()
```
    Returns:
    device number of the NIC on the referenced virtual machine
    Since:
    
    vcloud 0.9
  - getInternalPort
```
public Integer getInternalPort()
```
    network port to which this NAT rule maps the port number specified in the ExternalPort element.
  - getProtocol
```
public NatProtocol getProtocol()
```
    specifies the network protocol to which this rule applies
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class VmRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VmRule

Method Detail

getExternalIP

getExternalPort

getVAppScopedLocalId

getVmNicId

getInternalPort

getProtocol

equals

hashCode

toString