NodeRouteProperties (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class NodeRouteProperties
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Node network route properties

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NodeRouteProperties.Builder
Builder class for NodeRouteProperties.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`PROTO_BIRD`
`static java.lang.String`	`PROTO_BOOT`
`static java.lang.String`	`PROTO_DHCP`
`static java.lang.String`	`PROTO_DNROUTED`
`static java.lang.String`	`PROTO_GATED`
`static java.lang.String`	`PROTO_KERNEL`
`static java.lang.String`	`PROTO_MRT`
`static java.lang.String`	`PROTO_NTK`
`static java.lang.String`	`PROTO_RA`
`static java.lang.String`	`PROTO_REDIRECT`
`static java.lang.String`	`PROTO_STATIC`
`static java.lang.String`	`PROTO_UNSPEC`
`static java.lang.String`	`PROTO_XORP`
`static java.lang.String`	`PROTO_ZEBRA`
`static java.lang.String`	`ROUTE_TYPE_BLACKHOLE`
`static java.lang.String`	`ROUTE_TYPE_DEFAULT`
`static java.lang.String`	`ROUTE_TYPE_PROHIBIT`
`static java.lang.String`	`ROUTE_TYPE_STATIC`
`static java.lang.String`	`ROUTE_TYPE_THROW`
`static java.lang.String`	`ROUTE_TYPE_UNREACHABLE`

Constructor Summary

Constructors
Modifier Constructor and Description

NodeRouteProperties()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`NodeRouteProperties()` Default constructor.
`protected`	`NodeRouteProperties(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 NodeRouteProperties`	`_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 NodeRouteProperties`	`_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.lang.String`	`getDestination()` Destination covered by route
`java.lang.String`	`getFromAddress()` From address
`java.lang.String`	`getGateway()` Address of next hop
`java.lang.String`	`getInterfaceId()` Network interface id of route
`java.lang.Boolean`	`getIpv6()` IPv6 flag
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getMetric()` Default metric value for IPv4 is 0, whereas for IPv6 default value is 1024
`java.lang.String`	`getNetmask()` For IPv4 this field expects valid IPv4 netmask address, whereas in case of IPv6 it expects valid prefix length
`java.lang.String`	`getProto()` Possible values are: `PROTO_UNSPEC` `PROTO_REDIRECT` `PROTO_KERNEL` `PROTO_BOOT` `PROTO_STATIC` `PROTO_GATED` `PROTO_RA` `PROTO_MRT` `PROTO_ZEBRA` `PROTO_BIRD` `PROTO_DNROUTED` `PROTO_XORP` `PROTO_NTK` `PROTO_DHCP` Routing protocol identifier of route
`java.lang.String`	`getRouteId()` Unique identifier for the route This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getRouteType()` Possible values are: `ROUTE_TYPE_DEFAULT` `ROUTE_TYPE_STATIC` `ROUTE_TYPE_BLACKHOLE` `ROUTE_TYPE_PROHIBIT` `ROUTE_TYPE_THROW` `ROUTE_TYPE_UNREACHABLE` Route type
`java.lang.String`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getScope()` Scope of destinations covered by route
`SelfResourceLink`	`getSelf()`
`java.lang.String`	`getSrc()` Source address to prefer when sending to destinations of route
`int`	`hashCode()`
`void`	`setDestination(java.lang.String destination)` Destination covered by route
`void`	`setFromAddress(java.lang.String fromAddress)` From address
`void`	`setGateway(java.lang.String gateway)` Address of next hop
`void`	`setInterfaceId(java.lang.String interfaceId)` Network interface id of route
`void`	`setIpv6(java.lang.Boolean ipv6)` IPv6 flag
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setMetric(java.lang.String metric)` Default metric value for IPv4 is 0, whereas for IPv6 default value is 1024
`void`	`setNetmask(java.lang.String netmask)` For IPv4 this field expects valid IPv4 netmask address, whereas in case of IPv6 it expects valid prefix length
`void`	`setProto(java.lang.String proto)` Possible values are: `PROTO_UNSPEC` `PROTO_REDIRECT` `PROTO_KERNEL` `PROTO_BOOT` `PROTO_STATIC` `PROTO_GATED` `PROTO_RA` `PROTO_MRT` `PROTO_ZEBRA` `PROTO_BIRD` `PROTO_DNROUTED` `PROTO_XORP` `PROTO_NTK` `PROTO_DHCP` Routing protocol identifier of route
`void`	`setRouteId(java.lang.String routeId)` Unique identifier for the route This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setRouteType(java.lang.String routeType)` Possible values are: `ROUTE_TYPE_DEFAULT` `ROUTE_TYPE_STATIC` `ROUTE_TYPE_BLACKHOLE` `ROUTE_TYPE_PROHIBIT` `ROUTE_TYPE_THROW` `ROUTE_TYPE_UNREACHABLE` Route type
`void`	`setSchema(java.lang.String schema)` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setScope(java.lang.String scope)` Scope of destinations covered by route
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSrc(java.lang.String src)` Source address to prefer when sending to destinations of route
`java.lang.String`	`toString()`

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

- Field Detail
  - PROTO_UNSPEC
```
public static final java.lang.String PROTO_UNSPEC
```
    See Also:
    
    Constant Field Values
  - PROTO_REDIRECT
```
public static final java.lang.String PROTO_REDIRECT
```
    See Also:
    
    Constant Field Values
  - PROTO_KERNEL
```
public static final java.lang.String PROTO_KERNEL
```
    See Also:
    
    Constant Field Values
  - PROTO_BOOT
```
public static final java.lang.String PROTO_BOOT
```
    See Also:
    
    Constant Field Values
  - PROTO_STATIC
```
public static final java.lang.String PROTO_STATIC
```
    See Also:
    
    Constant Field Values
  - PROTO_GATED
```
public static final java.lang.String PROTO_GATED
```
    See Also:
    
    Constant Field Values
  - PROTO_RA
```
public static final java.lang.String PROTO_RA
```
    See Also:
    
    Constant Field Values
  - PROTO_MRT
```
public static final java.lang.String PROTO_MRT
```
    See Also:
    
    Constant Field Values
  - PROTO_ZEBRA
```
public static final java.lang.String PROTO_ZEBRA
```
    See Also:
    
    Constant Field Values
  - PROTO_BIRD
```
public static final java.lang.String PROTO_BIRD
```
    See Also:
    
    Constant Field Values
  - PROTO_DNROUTED
```
public static final java.lang.String PROTO_DNROUTED
```
    See Also:
    
    Constant Field Values
  - PROTO_XORP
```
public static final java.lang.String PROTO_XORP
```
    See Also:
    
    Constant Field Values
  - PROTO_NTK
```
public static final java.lang.String PROTO_NTK
```
    See Also:
    
    Constant Field Values
  - PROTO_DHCP
```
public static final java.lang.String PROTO_DHCP
```
    See Also:
    
    Constant Field Values
  - ROUTE_TYPE_DEFAULT
```
public static final java.lang.String ROUTE_TYPE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - ROUTE_TYPE_STATIC
```
public static final java.lang.String ROUTE_TYPE_STATIC
```
    See Also:
    
    Constant Field Values
  - ROUTE_TYPE_BLACKHOLE
```
public static final java.lang.String ROUTE_TYPE_BLACKHOLE
```
    See Also:
    
    Constant Field Values
  - ROUTE_TYPE_PROHIBIT
```
public static final java.lang.String ROUTE_TYPE_PROHIBIT
```
    See Also:
    
    Constant Field Values
  - ROUTE_TYPE_THROW
```
public static final java.lang.String ROUTE_TYPE_THROW
```
    See Also:
    
    Constant Field Values
  - ROUTE_TYPE_UNREACHABLE
```
public static final java.lang.String ROUTE_TYPE_UNREACHABLE
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - NodeRouteProperties
```
public NodeRouteProperties()
```
    Default constructor.
  - NodeRouteProperties
```
protected NodeRouteProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getDestination
```
public java.lang.String getDestination()
```
    Destination covered by route
    
    Returns:
    
    The current value of the property.
  - setDestination
```
public void setDestination(java.lang.String destination)
```
    Destination covered by route
    
    Parameters:
    
    destination - New value for the property.
  - getFromAddress
```
public java.lang.String getFromAddress()
```
    From address
    
    Returns:
    
    The current value of the property.
  - setFromAddress
```
public void setFromAddress(java.lang.String fromAddress)
```
    From address
    
    Parameters:
    
    fromAddress - New value for the property.
  - getGateway
```
public java.lang.String getGateway()
```
    Address of next hop
    
    Returns:
    
    The current value of the property.
  - setGateway
```
public void setGateway(java.lang.String gateway)
```
    Address of next hop
    
    Parameters:
    
    gateway - New value for the property.
  - getInterfaceId
```
public java.lang.String getInterfaceId()
```
    Network interface id of route
    
    Returns:
    
    The current value of the property.
  - setInterfaceId
```
public void setInterfaceId(java.lang.String interfaceId)
```
    Network interface id of route
    
    Parameters:
    
    interfaceId - New value for the property.
  - getIpv6
```
public java.lang.Boolean getIpv6()
```
    IPv6 flag
    
    Returns:
    
    The current value of the property.
  - setIpv6
```
public void setIpv6(java.lang.Boolean ipv6)
```
    IPv6 flag
    
    Parameters:
    
    ipv6 - New value for the property.
  - getMetric
```
public java.lang.String getMetric()
```
    Default metric value for IPv4 is 0, whereas for IPv6 default value is 1024
    
    Returns:
    
    The current value of the property.
  - setMetric
```
public void setMetric(java.lang.String metric)
```
    Default metric value for IPv4 is 0, whereas for IPv6 default value is 1024
    
    Parameters:
    
    metric - New value for the property.
  - getNetmask
```
public java.lang.String getNetmask()
```
    For IPv4 this field expects valid IPv4 netmask address, whereas in case of IPv6 it expects valid prefix length
    
    Returns:
    
    The current value of the property.
  - setNetmask
```
public void setNetmask(java.lang.String netmask)
```
    For IPv4 this field expects valid IPv4 netmask address, whereas in case of IPv6 it expects valid prefix length
    
    Parameters:
    
    netmask - New value for the property.
  - getProto
```
public java.lang.String getProto()
```
    Possible values are:
    Routing protocol identifier of route
    Returns:
    
    The current value of the property.
  - setProto
```
public void setProto(java.lang.String proto)
```
    Possible values are:
    Routing protocol identifier of route
    Parameters:
    
    proto - New value for the property.
  - getRouteId
```
public java.lang.String getRouteId()
```
    Unique identifier for the route This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setRouteId
```
public void setRouteId(java.lang.String routeId)
```
    Unique identifier for the route This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    routeId - New value for the property.
  - getRouteType
```
public java.lang.String getRouteType()
```
    Possible values are:
    Route type
    Returns:
    
    The current value of the property.
  - setRouteType
```
public void setRouteType(java.lang.String routeType)
```
    Possible values are:
    Route type
    Parameters:
    
    routeType - New value for the property.
  - getScope
```
public java.lang.String getScope()
```
    Scope of destinations covered by route
    
    Returns:
    
    The current value of the property.
  - setScope
```
public void setScope(java.lang.String scope)
```
    Scope of destinations covered by route
    
    Parameters:
    
    scope - New value for the property.
  - getSrc
```
public java.lang.String getSrc()
```
    Source address to prefer when sending to destinations of route
    
    Returns:
    
    The current value of the property.
  - setSrc
```
public void setSrc(java.lang.String src)
```
    Source address to prefer when sending to destinations of route
    
    Parameters:
    
    src - New value for 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 NodeRouteProperties _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 NodeRouteProperties _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class NodeRouteProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTO_UNSPEC

PROTO_REDIRECT

PROTO_KERNEL

PROTO_BOOT

PROTO_STATIC

PROTO_GATED

PROTO_RA

PROTO_MRT

PROTO_ZEBRA

PROTO_BIRD

PROTO_DNROUTED

PROTO_XORP

PROTO_NTK

PROTO_DHCP

ROUTE_TYPE_DEFAULT

ROUTE_TYPE_STATIC

ROUTE_TYPE_BLACKHOLE

ROUTE_TYPE_PROHIBIT

ROUTE_TYPE_THROW

ROUTE_TYPE_UNREACHABLE

__dynamicStructureFields

Constructor Detail

NodeRouteProperties

NodeRouteProperties

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getDestination

setDestination

getFromAddress

setFromAddress

getGateway

setGateway

getInterfaceId

setInterfaceId

getIpv6

setIpv6

getMetric

setMetric

getNetmask

setNetmask

getProto

setProto

getRouteId

setRouteId

getRouteType

setRouteType

getScope

setScope

getSrc

setSrc

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2