BatchNodeUserCreateParameters Class

Package:
com.azure.compute.batch.models
Maven Artifact:
com.azure:azure-compute-batch:1.0.0-beta.6
  • java.lang.Object
    • com.azure.compute.batch.models.BatchNodeUserCreateParameters

Implements

JsonSerializable<BatchNodeUserCreateParameters>

public final class BatchNodeUserCreateParameters
implements JsonSerializable<BatchNodeUserCreateParameters>

Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node.

Constructor Summary

Constructor Description
BatchNodeUserCreateParameters(String name)

Creates an instance of BatchNodeUserCreateParameters class.

Method Summary

Modifier and Type Method and Description
static BatchNodeUserCreateParameters fromJson(JsonReader jsonReader)

Reads an instance of BatchNodeUserCreateParameters from the JsonReader.
OffsetDateTime getExpiryTime()

Get the expiryTime property: The time at which the Account should expire.
String getName()

Get the name property: The user name of the Account.
String getPassword()

Get the password property: The password of the Account.
String getSshPublicKey()

Get the sshPublicKey property: The SSH public key that can be used for remote login to the Compute Node.
Boolean isAdmin()

Get the isAdmin property: Whether the Account should be an administrator on the Compute Node.
BatchNodeUserCreateParameters setExpiryTime(OffsetDateTime expiryTime)

Set the expiryTime property: The time at which the Account should expire.
BatchNodeUserCreateParameters setIsAdmin(Boolean isAdmin)

Set the isAdmin property: Whether the Account should be an administrator on the Compute Node.
BatchNodeUserCreateParameters setPassword(String password)

Set the password property: The password of the Account.
BatchNodeUserCreateParameters setSshPublicKey(String sshPublicKey)

Set the sshPublicKey property: The SSH public key that can be used for remote login to the Compute Node.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BatchNodeUserCreateParameters

public BatchNodeUserCreateParameters(String name)

Creates an instance of BatchNodeUserCreateParameters class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static BatchNodeUserCreateParameters fromJson(JsonReader jsonReader)

Reads an instance of BatchNodeUserCreateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchNodeUserCreateParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getExpiryTime

public OffsetDateTime getExpiryTime()

Get the expiryTime property: The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.

Returns:

the expiryTime value.

getName

public String getName()

Get the name property: The user name of the Account.

Returns:

the name value.

getPassword

public String getPassword()

Get the password property: The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.

Returns:

the password value.

getSshPublicKey

public String getSshPublicKey()

Get the sshPublicKey property: The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Returns:

the sshPublicKey value.

isAdmin

public Boolean isAdmin()

Get the isAdmin property: Whether the Account should be an administrator on the Compute Node. The default value is false.

Returns:

the isAdmin value.

setExpiryTime

public BatchNodeUserCreateParameters setExpiryTime(OffsetDateTime expiryTime)

Set the expiryTime property: The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.

Parameters:

expiryTime - the expiryTime value to set.

Returns:

the BatchNodeUserCreateParameters object itself.

setIsAdmin

public BatchNodeUserCreateParameters setIsAdmin(Boolean isAdmin)

Set the isAdmin property: Whether the Account should be an administrator on the Compute Node. The default value is false.

Parameters:

isAdmin - the isAdmin value to set.

Returns:

the BatchNodeUserCreateParameters object itself.

setPassword

public BatchNodeUserCreateParameters setPassword(String password)

Set the password property: The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.

Parameters:

password - the password value to set.

Returns:

the BatchNodeUserCreateParameters object itself.

setSshPublicKey

public BatchNodeUserCreateParameters setSshPublicKey(String sshPublicKey)

Set the sshPublicKey property: The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Parameters:

sshPublicKey - the sshPublicKey value to set.

Returns:

the BatchNodeUserCreateParameters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to