NodeUserProperties (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class NodeUserProperties
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Node user properties

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NodeUserProperties.Builder
Builder class for NodeUserProperties.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`STATUS_ACTIVE`
`static java.lang.String`	`STATUS_NOT_ACTIVATED`
`static java.lang.String`	`STATUS_PASSWORD_EXPIRED`

Constructor Summary

Constructors
Modifier Constructor and Description

NodeUserProperties()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`NodeUserProperties()` Default constructor.
`protected`	`NodeUserProperties(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 NodeUserProperties`	`_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 NodeUserProperties`	`_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`	`getFullName()` Full name for the user
`java.lang.Long`	`getGroupId()` Primary group id for the user 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.
`java.lang.String`	`getHomeDir()` The absolute path of user home directory This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.Long`	`getLastPasswordChange()` Number of days since password was last changed 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.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getLoginShell()` The absolute path of login shell This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getOldPassword()` Old password for the user (required on PUT if password specified)
`java.lang.String`	`getPassword()` Password for the user (optionally specified on PUT, unspecified on GET)
`java.lang.Long`	`getPasswordChangeFrequency()` Number of days password is valid before it must be changed.
`java.lang.Long`	`getPasswordChangeWarning()` Number of days before user receives warning message of password expiration format: int64
`java.lang.Boolean`	`getPasswordResetRequired()` Boolean value that states if a password reset is required
`java.lang.String`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`SelfResourceLink`	`getSelf()`
`java.lang.String`	`getStatus()` Possible values are: `STATUS_ACTIVE` `STATUS_PASSWORD_EXPIRED` `STATUS_NOT_ACTIVATED` Status of the user.
`java.lang.Long`	`getUserid()` Numeric id for the user 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.
`java.lang.String`	`getUsername()` User login name (must be \"root\" if userid is 0)
`int`	`hashCode()`
`void`	`setFullName(java.lang.String fullName)` Full name for the user
`void`	`setGroupId(java.lang.Long groupId)` Primary group id for the user 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.
`void`	`setHomeDir(java.lang.String homeDir)` The absolute path of user home directory This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setLastPasswordChange(java.lang.Long lastPasswordChange)` Number of days since password was last changed 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.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setLoginShell(java.lang.String loginShell)` The absolute path of login shell This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setOldPassword(java.lang.String oldPassword)` Old password for the user (required on PUT if password specified)
`void`	`setPassword(java.lang.String password)` Password for the user (optionally specified on PUT, unspecified on GET)
`void`	`setPasswordChangeFrequency(java.lang.Long passwordChangeFrequency)` Number of days password is valid before it must be changed.
`void`	`setPasswordChangeWarning(java.lang.Long passwordChangeWarning)` Number of days before user receives warning message of password expiration format: int64
`void`	`setPasswordResetRequired(java.lang.Boolean passwordResetRequired)` Boolean value that states if a password reset is required
`void`	`setSchema(java.lang.String schema)` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setStatus(java.lang.String status)` Possible values are: `STATUS_ACTIVE` `STATUS_PASSWORD_EXPIRED` `STATUS_NOT_ACTIVATED` Status of the user.
`void`	`setUserid(java.lang.Long userid)` Numeric id for the user 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.
`void`	`setUsername(java.lang.String username)` User login name (must be \"root\" if userid is 0)
`java.lang.String`	`toString()`

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

- Field Detail
  - STATUS_ACTIVE
```
public static final java.lang.String STATUS_ACTIVE
```
    See Also:
    
    Constant Field Values
  - STATUS_PASSWORD_EXPIRED
```
public static final java.lang.String STATUS_PASSWORD_EXPIRED
```
    See Also:
    
    Constant Field Values
  - STATUS_NOT_ACTIVATED
```
public static final java.lang.String STATUS_NOT_ACTIVATED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - NodeUserProperties
```
public NodeUserProperties()
```
    Default constructor.
  - NodeUserProperties
```
protected NodeUserProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. 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.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. 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:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource 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.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource 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:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getFullName
```
public java.lang.String getFullName()
```
    Full name for the user
    
    Returns:
    
    The current value of the property.
  - setFullName
```
public void setFullName(java.lang.String fullName)
```
    Full name for the user
    
    Parameters:
    
    fullName - New value for the property.
  - getGroupId
```
public java.lang.Long getGroupId()
```
    Primary group id for the user 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.
  - setGroupId
```
public void setGroupId(java.lang.Long groupId)
```
    Primary group id for the user 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:
    
    groupId - New value for the property.
  - getHomeDir
```
public java.lang.String getHomeDir()
```
    The absolute path of user home directory 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.
  - setHomeDir
```
public void setHomeDir(java.lang.String homeDir)
```
    The absolute path of user home directory 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:
    
    homeDir - New value for the property.
  - getLastPasswordChange
```
public java.lang.Long getLastPasswordChange()
```
    Number of days since password was last changed 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.
  - setLastPasswordChange
```
public void setLastPasswordChange(java.lang.Long lastPasswordChange)
```
    Number of days since password was last changed 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:
    
    lastPasswordChange - New value for the property.
  - getLoginShell
```
public java.lang.String getLoginShell()
```
    The absolute path of login shell 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.
  - setLoginShell
```
public void setLoginShell(java.lang.String loginShell)
```
    The absolute path of login shell 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:
    
    loginShell - New value for the property.
  - getOldPassword
```
public java.lang.String getOldPassword()
```
    Old password for the user (required on PUT if password specified)
    
    Returns:
    
    The current value of the property.
  - setOldPassword
```
public void setOldPassword(java.lang.String oldPassword)
```
    Old password for the user (required on PUT if password specified)
    
    Parameters:
    
    oldPassword - New value for the property.
  - getPassword
```
public java.lang.String getPassword()
```
    Password for the user (optionally specified on PUT, unspecified on GET)
    
    Returns:
    
    The current value of the property.
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Password for the user (optionally specified on PUT, unspecified on GET)
    
    Parameters:
    
    password - New value for the property.
  - getPasswordChangeFrequency
```
public java.lang.Long getPasswordChangeFrequency()
```
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days. format: int64
    
    Returns:
    
    The current value of the property.
  - setPasswordChangeFrequency
```
public void setPasswordChangeFrequency(java.lang.Long passwordChangeFrequency)
```
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days. format: int64
    
    Parameters:
    
    passwordChangeFrequency - New value for the property.
  - getPasswordChangeWarning
```
public java.lang.Long getPasswordChangeWarning()
```
    Number of days before user receives warning message of password expiration format: int64
    
    Returns:
    
    The current value of the property.
  - setPasswordChangeWarning
```
public void setPasswordChangeWarning(java.lang.Long passwordChangeWarning)
```
    Number of days before user receives warning message of password expiration format: int64
    
    Parameters:
    
    passwordChangeWarning - New value for the property.
  - getPasswordResetRequired
```
public java.lang.Boolean getPasswordResetRequired()
```
    Boolean value that states if a password reset is required
    
    Returns:
    
    The current value of the property.
  - setPasswordResetRequired
```
public void setPasswordResetRequired(java.lang.Boolean passwordResetRequired)
```
    Boolean value that states if a password reset is required
    
    Parameters:
    
    passwordResetRequired - New value for the property.
  - getStatus
```
public java.lang.String getStatus()
```
    Possible values are:
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate. 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.
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Possible values are:
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate. 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:
    
    status - New value for the property.
  - getUserid
```
public java.lang.Long getUserid()
```
    Numeric id for the user 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.
  - setUserid
```
public void setUserid(java.lang.Long userid)
```
    Numeric id for the user 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:
    
    userid - New value for the property.
  - getUsername
```
public java.lang.String getUsername()
```
    User login name (must be \"root\" if userid is 0)
    
    Returns:
    
    The current value of the property.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    User login name (must be \"root\" if userid is 0)
    
    Parameters:
    
    username - 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 NodeUserProperties _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 NodeUserProperties _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class NodeUserProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_ACTIVE

STATUS_PASSWORD_EXPIRED

STATUS_NOT_ACTIVATED

__dynamicStructureFields

Constructor Detail

NodeUserProperties

NodeUserProperties

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getFullName

setFullName

getGroupId

setGroupId

getHomeDir

setHomeDir

getLastPasswordChange

setLastPasswordChange

getLoginShell

setLoginShell

getOldPassword

setOldPassword

getPassword

setPassword

getPasswordChangeFrequency

setPasswordChangeFrequency

getPasswordChangeWarning

setPasswordChangeWarning

getPasswordResetRequired

setPasswordResetRequired

getStatus

setStatus

getUserid

setUserid

getUsername

setUsername

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2