Attribute (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class Attribute
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Attribute specific to a partner. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. The Attributes used by the partner applicance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Attribute.Builder
Builder class for Attribute.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ATTRIBUTE_TYPE_BOOLEAN`
`static java.lang.String`	`ATTRIBUTE_TYPE_IP_ADDRESS`
`static java.lang.String`	`ATTRIBUTE_TYPE_LONG`
`static java.lang.String`	`ATTRIBUTE_TYPE_PASSWORD`
`static java.lang.String`	`ATTRIBUTE_TYPE_PORT`
`static java.lang.String`	`ATTRIBUTE_TYPE_STRING`

Constructor Summary

Constructors
Modifier Constructor and Description

Attribute()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`Attribute()` Default constructor.
`protected`	`Attribute(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 Attribute`	`_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 Attribute`	`_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`	`getAttributeType()` Possible values are: `ATTRIBUTE_TYPE_IP_ADDRESS` `ATTRIBUTE_TYPE_PORT` `ATTRIBUTE_TYPE_PASSWORD` `ATTRIBUTE_TYPE_STRING` `ATTRIBUTE_TYPE_LONG` `ATTRIBUTE_TYPE_BOOLEAN` Attribute Type can be of any of the allowed enum type.
`java.lang.String`	`getDisplayName()` Attribute display name string value.
`java.lang.String`	`getKey()` Attribute key string value.
`java.lang.Boolean`	`getReadOnly()` Read only Attribute cannot be overdidden by service instance/deployment.
`java.lang.String`	`getValue()` Attribute value string value.
`int`	`hashCode()`
`void`	`setAttributeType(java.lang.String attributeType)` Possible values are: `ATTRIBUTE_TYPE_IP_ADDRESS` `ATTRIBUTE_TYPE_PORT` `ATTRIBUTE_TYPE_PASSWORD` `ATTRIBUTE_TYPE_STRING` `ATTRIBUTE_TYPE_LONG` `ATTRIBUTE_TYPE_BOOLEAN` Attribute Type can be of any of the allowed enum type.
`void`	`setDisplayName(java.lang.String displayName)` Attribute display name string value.
`void`	`setKey(java.lang.String key)` Attribute key string value.
`void`	`setReadOnly(java.lang.Boolean readOnly)` Read only Attribute cannot be overdidden by service instance/deployment.
`void`	`setValue(java.lang.String value)` Attribute value string value.
`java.lang.String`	`toString()`

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

- Field Detail
  - ATTRIBUTE_TYPE_IP_ADDRESS
```
public static final java.lang.String ATTRIBUTE_TYPE_IP_ADDRESS
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_TYPE_PORT
```
public static final java.lang.String ATTRIBUTE_TYPE_PORT
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_TYPE_PASSWORD
```
public static final java.lang.String ATTRIBUTE_TYPE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_TYPE_STRING
```
public static final java.lang.String ATTRIBUTE_TYPE_STRING
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_TYPE_LONG
```
public static final java.lang.String ATTRIBUTE_TYPE_LONG
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_TYPE_BOOLEAN
```
public static final java.lang.String ATTRIBUTE_TYPE_BOOLEAN
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - Attribute
```
public Attribute()
```
    Default constructor.
  - Attribute
```
protected Attribute(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAttributeType
```
public java.lang.String getAttributeType()
```
    Possible values are:
    Attribute Type can be of any of the allowed enum type.
    Returns:
    
    The current value of the property.
  - setAttributeType
```
public void setAttributeType(java.lang.String attributeType)
```
    Possible values are:
    Attribute Type can be of any of the allowed enum type.
    Parameters:
    
    attributeType - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Attribute display name string value.
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Attribute display name string value.
    
    Parameters:
    
    displayName - New value for the property.
  - getKey
```
public java.lang.String getKey()
```
    Attribute key string value.
    
    Returns:
    
    The current value of the property.
  - setKey
```
public void setKey(java.lang.String key)
```
    Attribute key string value.
    
    Parameters:
    
    key - New value for the property.
  - getReadOnly
```
public java.lang.Boolean getReadOnly()
```
    Read only Attribute cannot be overdidden by service instance/deployment.
    
    Returns:
    
    The current value of the property.
  - setReadOnly
```
public void setReadOnly(java.lang.Boolean readOnly)
```
    Read only Attribute cannot be overdidden by service instance/deployment.
    
    Parameters:
    
    readOnly - New value for the property.
  - getValue
```
public java.lang.String getValue()
```
    Attribute value string value.
    
    Returns:
    
    The current value of the property.
  - setValue
```
public void setValue(java.lang.String value)
```
    Attribute value string value.
    
    Parameters:
    
    value - 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 Attribute _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 Attribute _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class Attribute

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTRIBUTE_TYPE_IP_ADDRESS

ATTRIBUTE_TYPE_PORT

ATTRIBUTE_TYPE_PASSWORD

ATTRIBUTE_TYPE_STRING

ATTRIBUTE_TYPE_LONG

ATTRIBUTE_TYPE_BOOLEAN

__dynamicStructureFields

Constructor Detail

Attribute

Attribute

Method Detail

getAttributeType

setAttributeType

getDisplayName

setDisplayName

getKey

setKey

getReadOnly

setReadOnly

getValue

setValue

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2