NsxRole (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class NsxRole
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Role

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NsxRole.Builder
Builder class for NsxRole.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`PERMISSIONS_CRUD`
`static java.lang.String`	`PERMISSIONS_EXECUTE`
`static java.lang.String`	`PERMISSIONS_NONE`
`static java.lang.String`	`PERMISSIONS_READ`
`static java.lang.String`	`PERMISSIONS_READ_API`
`static java.lang.String`	`PERMISSIONS_READ_WRITE_API`

Constructor Summary

Constructors
Modifier Constructor and Description

NsxRole()
Default constructor.

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated 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 NsxRole`	`_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 NsxRole`	`_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.util.List<java.lang.String>`	`getPermissions()` Deprecated.
`java.lang.String`	`getRole()` This field represents the identifier of the role.
`int`	`hashCode()`
`void`	`setPermissions(java.util.List<java.lang.String> permissions)` Deprecated.
`void`	`setRole(java.lang.String role)` This field represents the identifier of the role.
`java.lang.String`	`toString()`

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

- Field Detail
  - PERMISSIONS_READ_API
```
public static final java.lang.String PERMISSIONS_READ_API
```
    See Also:
    
    Constant Field Values
  - PERMISSIONS_READ_WRITE_API
```
public static final java.lang.String PERMISSIONS_READ_WRITE_API
```
    See Also:
    
    Constant Field Values
  - PERMISSIONS_CRUD
```
public static final java.lang.String PERMISSIONS_CRUD
```
    See Also:
    
    Constant Field Values
  - PERMISSIONS_READ
```
public static final java.lang.String PERMISSIONS_READ
```
    See Also:
    
    Constant Field Values
  - PERMISSIONS_EXECUTE
```
public static final java.lang.String PERMISSIONS_EXECUTE
```
    See Also:
    
    Constant Field Values
  - PERMISSIONS_NONE
```
public static final java.lang.String PERMISSIONS_NONE
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - NsxRole
```
public NsxRole()
```
    Default constructor.
  - NsxRole
```
protected NsxRole(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getPermissions
```
@Deprecated
public java.util.List<java.lang.String> getPermissions()
```
    Deprecated.
    Possible values are:
    Please use the /user-info/permissions api to get the permission that the user has on each feature.
    Returns:
    
    The current value of the property.
  - setPermissions
```
@Deprecated
public void setPermissions(java.util.List<java.lang.String> permissions)
```
    Deprecated.
    Possible values are:
    Please use the /user-info/permissions api to get the permission that the user has on each feature.
    Parameters:
    
    permissions - New value for the property.
  - getRole
```
public java.lang.String getRole()
```
    This field represents the identifier of the role. With the introduction of custom roles, this field is no longer an enum.
    
    Returns:
    
    The current value of the property.
  - setRole
```
public void setRole(java.lang.String role)
```
    This field represents the identifier of the role. With the introduction of custom roles, this field is no longer an enum.
    
    Parameters:
    
    role - 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 NsxRole _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 NsxRole _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class NsxRole

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERMISSIONS_READ_API

PERMISSIONS_READ_WRITE_API

PERMISSIONS_CRUD

PERMISSIONS_READ

PERMISSIONS_EXECUTE

PERMISSIONS_NONE

__dynamicStructureFields

Constructor Detail

NsxRole

NsxRole

Method Detail

getPermissions

setPermissions

getRole

setRole

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2