ServicePathHop (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ServicePathHop
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Represents a service VM implementing a particular service in a service chain

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ServicePathHop.Builder
Builder class for ServicePathHop.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ACTION_COPY`
`static java.lang.String`	`ACTION_REDIRECT`
`static java.lang.String`	`ACTION_SERVICE_ACTION_INVALID`

Constructor Summary

Constructors
Modifier Constructor and Description

ServicePathHop()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`ServicePathHop()` Default constructor.
`protected`	`ServicePathHop(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 ServicePathHop`	`_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 ServicePathHop`	`_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`	`getAction()` Possible values are: `ACTION_SERVICE_ACTION_INVALID` `ACTION_COPY` `ACTION_REDIRECT` Action that will be taken by the corresponding service VM of the hop.
`java.lang.Boolean`	`getCanDecrementSi()` Indicating whether service is configured to decrement SI field in NSH metadata.
`java.lang.Boolean`	`getInMaintenanceMode()` Indicating the maintenance mode of the corresponding service VM.
`java.lang.Boolean`	`getIsActiveFromCcp()` Indicating whether the corresponding service VM is active or not per CCP.
`java.lang.Boolean`	`getIsActiveFromDp()` Indicating whether the corresponding service VM is active or not per DP.
`java.lang.Boolean`	`getIsActiveFromMp()` Indicating whether the corresponding service VM is active or not per MP.
`java.lang.String`	`getMacAddress()` MAC address of the virtual network interface.
`java.lang.Boolean`	`getNshLivenessSupport()` Indicating whether NSH liveness is supported or not by the corresponding service VM.
`java.lang.String`	`getVif()` ID of the virtual network interface.
`int`	`hashCode()`
`void`	`setAction(java.lang.String action)` Possible values are: `ACTION_SERVICE_ACTION_INVALID` `ACTION_COPY` `ACTION_REDIRECT` Action that will be taken by the corresponding service VM of the hop.
`void`	`setCanDecrementSi(java.lang.Boolean canDecrementSi)` Indicating whether service is configured to decrement SI field in NSH metadata.
`void`	`setInMaintenanceMode(java.lang.Boolean inMaintenanceMode)` Indicating the maintenance mode of the corresponding service VM.
`void`	`setIsActiveFromCcp(java.lang.Boolean isActiveFromCcp)` Indicating whether the corresponding service VM is active or not per CCP.
`void`	`setIsActiveFromDp(java.lang.Boolean isActiveFromDp)` Indicating whether the corresponding service VM is active or not per DP.
`void`	`setIsActiveFromMp(java.lang.Boolean isActiveFromMp)` Indicating whether the corresponding service VM is active or not per MP.
`void`	`setMacAddress(java.lang.String macAddress)` MAC address of the virtual network interface.
`void`	`setNshLivenessSupport(java.lang.Boolean nshLivenessSupport)` Indicating whether NSH liveness is supported or not by the corresponding service VM.
`void`	`setVif(java.lang.String vif)` ID of the virtual network interface.
`java.lang.String`	`toString()`

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

- Field Detail
  - ACTION_SERVICE_ACTION_INVALID
```
public static final java.lang.String ACTION_SERVICE_ACTION_INVALID
```
    See Also:
    
    Constant Field Values
  - ACTION_COPY
```
public static final java.lang.String ACTION_COPY
```
    See Also:
    
    Constant Field Values
  - ACTION_REDIRECT
```
public static final java.lang.String ACTION_REDIRECT
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ServicePathHop
```
public ServicePathHop()
```
    Default constructor.
  - ServicePathHop
```
protected ServicePathHop(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAction
```
public java.lang.String getAction()
```
    Possible values are:
    Action that will be taken by the corresponding service VM of the hop. 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.
  - setAction
```
public void setAction(java.lang.String action)
```
    Possible values are:
    Action that will be taken by the corresponding service VM of the hop. 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:
    
    action - New value for the property.
  - getCanDecrementSi
```
public java.lang.Boolean getCanDecrementSi()
```
    Indicating whether service is configured to decrement SI field in NSH metadata. 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.
  - setCanDecrementSi
```
public void setCanDecrementSi(java.lang.Boolean canDecrementSi)
```
    Indicating whether service is configured to decrement SI field in NSH metadata. 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:
    
    canDecrementSi - New value for the property.
  - getInMaintenanceMode
```
public java.lang.Boolean getInMaintenanceMode()
```
    Indicating the maintenance mode of the corresponding service VM. 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.
  - setInMaintenanceMode
```
public void setInMaintenanceMode(java.lang.Boolean inMaintenanceMode)
```
    Indicating the maintenance mode of the corresponding service VM. 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:
    
    inMaintenanceMode - New value for the property.
  - getIsActiveFromCcp
```
public java.lang.Boolean getIsActiveFromCcp()
```
    Indicating whether the corresponding service VM is active or not per CCP. 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.
  - setIsActiveFromCcp
```
public void setIsActiveFromCcp(java.lang.Boolean isActiveFromCcp)
```
    Indicating whether the corresponding service VM is active or not per CCP. 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:
    
    isActiveFromCcp - New value for the property.
  - getIsActiveFromDp
```
public java.lang.Boolean getIsActiveFromDp()
```
    Indicating whether the corresponding service VM is active or not per DP. 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.
  - setIsActiveFromDp
```
public void setIsActiveFromDp(java.lang.Boolean isActiveFromDp)
```
    Indicating whether the corresponding service VM is active or not per DP. 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:
    
    isActiveFromDp - New value for the property.
  - getIsActiveFromMp
```
public java.lang.Boolean getIsActiveFromMp()
```
    Indicating whether the corresponding service VM is active or not per MP. 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.
  - setIsActiveFromMp
```
public void setIsActiveFromMp(java.lang.Boolean isActiveFromMp)
```
    Indicating whether the corresponding service VM is active or not per MP. 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:
    
    isActiveFromMp - New value for the property.
  - getMacAddress
```
public java.lang.String getMacAddress()
```
    MAC address of the virtual network interface. 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.
  - setMacAddress
```
public void setMacAddress(java.lang.String macAddress)
```
    MAC address of the virtual network interface. 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:
    
    macAddress - New value for the property.
  - getNshLivenessSupport
```
public java.lang.Boolean getNshLivenessSupport()
```
    Indicating whether NSH liveness is supported or not by the corresponding service VM. 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.
  - setNshLivenessSupport
```
public void setNshLivenessSupport(java.lang.Boolean nshLivenessSupport)
```
    Indicating whether NSH liveness is supported or not by the corresponding service VM. 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:
    
    nshLivenessSupport - New value for the property.
  - getVif
```
public java.lang.String getVif()
```
    ID of the virtual network interface. 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.
  - setVif
```
public void setVif(java.lang.String vif)
```
    ID of the virtual network interface. 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:
    
    vif - 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 ServicePathHop _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 ServicePathHop _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ServicePathHop

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION_SERVICE_ACTION_INVALID

ACTION_COPY

ACTION_REDIRECT

__dynamicStructureFields

Constructor Detail

ServicePathHop

ServicePathHop

Method Detail

getAction

setAction

getCanDecrementSi

setCanDecrementSi

getInMaintenanceMode

setInMaintenanceMode

getIsActiveFromCcp

setIsActiveFromCcp

getIsActiveFromDp

setIsActiveFromDp

getIsActiveFromMp

setIsActiveFromMp

getMacAddress

setMacAddress

getNshLivenessSupport

setNshLivenessSupport

getVif

setVif

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2