com.vmware.nsx.model

Class Header

java.lang.Object

com.vmware.nsx.model.Header

All Implemented Interfaces:

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

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

Header of a widget that provides additional information. This will be shown at the container level. It includes details as label value pairs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	Header() Default constructor.
protected	Header(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 Header	_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 Header	_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	getCondition() If the condition is met then the header will be applied.
java.lang.String	getContentAlignment() Possible values are: CONTENT_ALIGNMENT_LEFT CONTENT_ALIGNMENT_RIGHT Alignment of header labels.
java.util.List<PropertyItem>	getSubHeaders() Deprecated.
java.util.List<WidgetItem>	getSubHeaderWidgets() An array of widgets which will appear inside the container header Instead of 'sub_headers' property use this property.
int	hashCode()
void	setCondition(java.lang.String condition) If the condition is met then the header will be applied.
void	setContentAlignment(java.lang.String contentAlignment) Possible values are: CONTENT_ALIGNMENT_LEFT CONTENT_ALIGNMENT_RIGHT Alignment of header labels.
void	setSubHeaders(java.util.List<PropertyItem> subHeaders) Deprecated.
void	setSubHeaderWidgets(java.util.List<WidgetItem> subHeaderWidgets) An array of widgets which will appear inside the container header Instead of 'sub_headers' property use this property.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_ALIGNMENT_LEFT

public static final java.lang.String CONTENT_ALIGNMENT_LEFT

See Also:

Constant Field Values

CONTENT_ALIGNMENT_RIGHT

public static final java.lang.String CONTENT_ALIGNMENT_RIGHT

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

Header

public Header()

Default constructor.

Header

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

Method Detail

getCondition

public java.lang.String getCondition()

If the condition is met then the header will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.

Returns:

The current value of the property.

setCondition

public void setCondition(java.lang.String condition)

If the condition is met then the header will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.

Parameters:

condition - New value for the property.

getContentAlignment

public java.lang.String getContentAlignment()

Possible values are:

• CONTENT_ALIGNMENT_LEFT
• CONTENT_ALIGNMENT_RIGHT

Alignment of header labels.

Returns:

The current value of the property.

setContentAlignment

public void setContentAlignment(java.lang.String contentAlignment)

Possible values are:

• CONTENT_ALIGNMENT_LEFT
• CONTENT_ALIGNMENT_RIGHT

Alignment of header labels.

Parameters:

contentAlignment - New value for the property.

getSubHeaderWidgets

public java.util.List<WidgetItem> getSubHeaderWidgets()

An array of widgets which will appear inside the container header Instead of 'sub_headers' property use this property.

Returns:

The current value of the property.

setSubHeaderWidgets

public void setSubHeaderWidgets(java.util.List<WidgetItem> subHeaderWidgets)

An array of widgets which will appear inside the container header Instead of 'sub_headers' property use this property.

Parameters:

subHeaderWidgets - New value for the property.

getSubHeaders

@Deprecated
public java.util.List<PropertyItem> getSubHeaders()

Deprecated.

An array of label-value properties. This field is deprecated instead used 'sub_header_widgets' property to define header widgets.

Returns:

The current value of the property.

setSubHeaders

@Deprecated
public void setSubHeaders(java.util.List<PropertyItem> subHeaders)

Deprecated.

An array of label-value properties. This field is deprecated instead used 'sub_header_widgets' property to define header widgets.

Parameters:

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

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