Class UserAccount
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the elevationLevel property: The elevation level of the user.Get the linuxUserConfiguration property: Properties used to create a user account on a Linux node.name()
Get the name property: The name of the user account.password()
Get the password property: The password for the user account.void
validate()
Validates the instance.Get the windowsUserConfiguration property: Properties used to create a user account on a Windows node.withElevationLevel
(ElevationLevel elevationLevel) Set the elevationLevel property: The elevation level of the user.withLinuxUserConfiguration
(LinuxUserConfiguration linuxUserConfiguration) Set the linuxUserConfiguration property: Properties used to create a user account on a Linux node.Set the name property: The name of the user account.withPassword
(String password) Set the password property: The password for the user account.withWindowsUserConfiguration
(WindowsUserConfiguration windowsUserConfiguration) Set the windowsUserConfiguration property: Properties used to create a user account on a Windows node.
-
Constructor Details
-
UserAccount
public UserAccount()Creates an instance of UserAccount class.
-
-
Method Details
-
name
Get the name property: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.- Returns:
- the name value.
-
withName
Set the name property: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.- Parameters:
name
- the name value to set.- Returns:
- the UserAccount object itself.
-
password
Get the password property: The password for the user account.- Returns:
- the password value.
-
withPassword
Set the password property: The password for the user account.- Parameters:
password
- the password value to set.- Returns:
- the UserAccount object itself.
-
elevationLevel
Get the elevationLevel property: The elevation level of the user.nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- Returns:
- the elevationLevel value.
-
withElevationLevel
Set the elevationLevel property: The elevation level of the user.nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.
- Parameters:
elevationLevel
- the elevationLevel value to set.- Returns:
- the UserAccount object itself.
-
linuxUserConfiguration
Get the linuxUserConfiguration property: Properties used to create a user account on a Linux node.This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.
- Returns:
- the linuxUserConfiguration value.
-
withLinuxUserConfiguration
Set the linuxUserConfiguration property: Properties used to create a user account on a Linux node.This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.
- Parameters:
linuxUserConfiguration
- the linuxUserConfiguration value to set.- Returns:
- the UserAccount object itself.
-
windowsUserConfiguration
Get the windowsUserConfiguration property: Properties used to create a user account on a Windows node.This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
- Returns:
- the windowsUserConfiguration value.
-
withWindowsUserConfiguration
Set the windowsUserConfiguration property: Properties used to create a user account on a Windows node.This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
- Parameters:
windowsUserConfiguration
- the windowsUserConfiguration value to set.- Returns:
- the UserAccount object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-