com.vmware.nsx.model

Class ServiceChainMapping

java.lang.Object

com.vmware.nsx.model.ServiceChainMapping

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class ServiceChainMapping
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

A ServiceInsertionServiceProfile can be part of multiple ServiceChains. ServiceChainMapping for a particular profile will contain a list of all the ServiceChains it's part of. Each Mapping will also contain some metadata to uniquely identify a profile from other profiles.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceChainMapping.Builder Builder class for ServiceChainMapping.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	DIRECTION_FORWARD
static java.lang.String	DIRECTION_REVERSE

Constructor Summary

Constructors

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

Method Summary

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 ServiceChainMapping	_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 ServiceChainMapping	_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	getDirection() Possible values are: DIRECTION_FORWARD DIRECTION_REVERSE Each ServiceChain has forward_path_service_profiles and reverse_path_service_profiles.
java.lang.String	getServiceChainId() A unique id generated for every ServiceChain.
java.lang.Long	getServiceIndex() Service Index represents a numerical position of a ServiceInsertionServiceProfile in a ServiceChain.
int	hashCode()
void	setDirection(java.lang.String direction) Possible values are: DIRECTION_FORWARD DIRECTION_REVERSE Each ServiceChain has forward_path_service_profiles and reverse_path_service_profiles.
void	setServiceChainId(java.lang.String serviceChainId) A unique id generated for every ServiceChain.
void	setServiceIndex(java.lang.Long serviceIndex) Service Index represents a numerical position of a ServiceInsertionServiceProfile in a ServiceChain.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DIRECTION_FORWARD

public static final java.lang.String DIRECTION_FORWARD

See Also:

Constant Field Values

DIRECTION_REVERSE

public static final java.lang.String DIRECTION_REVERSE

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

ServiceChainMapping

public ServiceChainMapping()

Default constructor.

ServiceChainMapping

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

Method Detail

getDirection

public java.lang.String getDirection()

Possible values are:

• DIRECTION_FORWARD
• DIRECTION_REVERSE

Each ServiceChain has forward_path_service_profiles and reverse_path_service_profiles. This property will indicate which of them being used. FORWARD - forward_path_service_profiles REVERSE - reverse_path_service_profiles 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.

setDirection

public void setDirection(java.lang.String direction)

Possible values are:

• DIRECTION_FORWARD
• DIRECTION_REVERSE

Each ServiceChain has forward_path_service_profiles and reverse_path_service_profiles. This property will indicate which of them being used. FORWARD - forward_path_service_profiles REVERSE - reverse_path_service_profiles 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:

direction - New value for the property.

getServiceChainId

public java.lang.String getServiceChainId()

A unique id generated for every ServiceChain. This is not a uuid. 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.

setServiceChainId

public void setServiceChainId(java.lang.String serviceChainId)

A unique id generated for every ServiceChain. This is not a uuid. 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:

serviceChainId - New value for the property.

getServiceIndex

public java.lang.Long getServiceIndex()

Service Index represents a numerical position of a ServiceInsertionServiceProfile in a ServiceChain. It will be in reverse order. Service Index can point to either forward_path_service_profiles or reverse_path_service_profiles indicated by direction property. Example - For a ServiceChain A-B-C, A will have index of 3, B will have index of 2 and C will have index of 1. format: int64 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.

setServiceIndex

public void setServiceIndex(java.lang.Long serviceIndex)

Service Index represents a numerical position of a ServiceInsertionServiceProfile in a ServiceChain. It will be in reverse order. Service Index can point to either forward_path_service_profiles or reverse_path_service_profiles indicated by direction property. Example - For a ServiceChain A-B-C, A will have index of 3, B will have index of 2 and C will have index of 1. format: int64 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:

serviceIndex - 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 ServiceChainMapping _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 ServiceChainMapping _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.