IPMirrorDestination (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.IPMirrorDestination

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class IPMirrorDestination
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IPMirrorDestination.Builder
Builder class for IPMirrorDestination.

Nested Classes
Modifier and Type	Class and Description
`static class`	`IPMirrorDestination.Builder` Builder class for `IPMirrorDestination`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.
`static java.lang.String`	`ENCAPSULATION_TYPE_ERSPAN_THREE`
`static java.lang.String`	`ENCAPSULATION_TYPE_ERSPAN_TWO`
`static java.lang.String`	`ENCAPSULATION_TYPE_GRE`

Constructor Summary

Constructors
Modifier Constructor and Description

IPMirrorDestination()
Default constructor.

protected IPMirrorDestination(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`IPMirrorDestination()` Default constructor.
`protected`	`IPMirrorDestination(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static IPMirrorDestination`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static IPMirrorDestination`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getDestinationIps()` The destination IPs of the mirror packet will be sent to.
`java.lang.String`	`getEncapsulationType()` Possible values are: `ENCAPSULATION_TYPE_GRE` `ENCAPSULATION_TYPE_ERSPAN_TWO` `ENCAPSULATION_TYPE_ERSPAN_THREE` You can choose GRE, ERSPAN II or ERSPAN III.
`java.lang.Long`	`getErspanId()` Used by physical switch for the mirror traffic forwarding.
`java.lang.Long`	`getGreKey()` User-configurable 32-bit key only for GRE format: int32
`java.lang.String`	`getResourceType()` Possible values are: `MirrorDestination.RESOURCE_TYPE_LOGICALPORTMIRRORDESTINATION` `MirrorDestination.RESOURCE_TYPE_PNICMIRRORDESTINATION` `MirrorDestination.RESOURCE_TYPE_IPMIRRORDESTINATION` Resource types of mirror destination The value of this property is automatically populated to `"IPMirrorDestination"`.
`int`	`hashCode()`
`void`	`setDestinationIps(java.util.List<java.lang.String> destinationIps)` The destination IPs of the mirror packet will be sent to.
`void`	`setEncapsulationType(java.lang.String encapsulationType)` Possible values are: `ENCAPSULATION_TYPE_GRE` `ENCAPSULATION_TYPE_ERSPAN_TWO` `ENCAPSULATION_TYPE_ERSPAN_THREE` You can choose GRE, ERSPAN II or ERSPAN III.
`void`	`setErspanId(java.lang.Long erspanId)` Used by physical switch for the mirror traffic forwarding.
`void`	`setGreKey(java.lang.Long greKey)` User-configurable 32-bit key only for GRE format: int32
`java.lang.String`	`toString()`

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

- Field Detail
  - _TYPE_IDENTIFIER
```
public static final java.lang.String _TYPE_IDENTIFIER
```
    Identifier denoting this class, when it is used in polymorphic context.
    This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
    
    See Also:
    
    Constant Field Values
  - ENCAPSULATION_TYPE_GRE
```
public static final java.lang.String ENCAPSULATION_TYPE_GRE
```
    See Also:
    
    Constant Field Values
  - ENCAPSULATION_TYPE_ERSPAN_TWO
```
public static final java.lang.String ENCAPSULATION_TYPE_ERSPAN_TWO
```
    See Also:
    
    Constant Field Values
  - ENCAPSULATION_TYPE_ERSPAN_THREE
```
public static final java.lang.String ENCAPSULATION_TYPE_ERSPAN_THREE
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - IPMirrorDestination
```
public IPMirrorDestination()
```
    Default constructor.
  - IPMirrorDestination
```
protected IPMirrorDestination(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getDestinationIps
```
public java.util.List<java.lang.String> getDestinationIps()
```
    The destination IPs of the mirror packet will be sent to. format: ip
    
    Returns:
    
    The current value of the property.
  - setDestinationIps
```
public void setDestinationIps(java.util.List<java.lang.String> destinationIps)
```
    The destination IPs of the mirror packet will be sent to. format: ip
    
    Parameters:
    
    destinationIps - New value for the property.
  - getEncapsulationType
```
public java.lang.String getEncapsulationType()
```
    Possible values are:
    You can choose GRE, ERSPAN II or ERSPAN III.
    Returns:
    
    The current value of the property.
  - setEncapsulationType
```
public void setEncapsulationType(java.lang.String encapsulationType)
```
    Possible values are:
    You can choose GRE, ERSPAN II or ERSPAN III.
    Parameters:
    
    encapsulationType - New value for the property.
  - getErspanId
```
public java.lang.Long getErspanId()
```
    Used by physical switch for the mirror traffic forwarding. Must be provided and only effective when encapsulation type is ERSPAN type II or type III. format: int32
    
    Returns:
    
    The current value of the property.
  - setErspanId
```
public void setErspanId(java.lang.Long erspanId)
```
    Used by physical switch for the mirror traffic forwarding. Must be provided and only effective when encapsulation type is ERSPAN type II or type III. format: int32
    
    Parameters:
    
    erspanId - New value for the property.
  - getGreKey
```
public java.lang.Long getGreKey()
```
    User-configurable 32-bit key only for GRE format: int32
    
    Returns:
    
    The current value of the property.
  - setGreKey
```
public void setGreKey(java.lang.Long greKey)
```
    User-configurable 32-bit key only for GRE format: int32
    
    Parameters:
    
    greKey - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    Possible values are:
    Resource types of mirror destination The value of this property is automatically populated to "IPMirrorDestination".
    Returns:
    
    The current value of the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static IPMirrorDestination _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static IPMirrorDestination _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class IPMirrorDestination

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

ENCAPSULATION_TYPE_GRE

ENCAPSULATION_TYPE_ERSPAN_TWO

ENCAPSULATION_TYPE_ERSPAN_THREE

__dynamicStructureFields

Constructor Detail

IPMirrorDestination

IPMirrorDestination

Method Detail

getDestinationIps

setDestinationIps

getEncapsulationType

setEncapsulationType

getErspanId

setErspanId

getGreKey

setGreKey

getResourceType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2