Share via


AuthenticationTokenSettings Class

  • java.lang.Object
    • com.azure.compute.batch.models.AuthenticationTokenSettings

Implements

public final class AuthenticationTokenSettings
implements JsonSerializable<AuthenticationTokenSettings>

The settings for an authentication token that the Task can use to perform Batch service operations.

Constructor Summary

Constructor Description
AuthenticationTokenSettings()

Creates an instance of AuthenticationTokenSettings class.

Method Summary

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

Reads an instance of AuthenticationTokenSettings from the JsonReader.

List<BatchAccessScope> getAccess()

Get the access property: The Batch resources to which the token grants access.

AuthenticationTokenSettings setAccess(List<BatchAccessScope> access)

Set the access property: The Batch resources to which the token grants access.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

AuthenticationTokenSettings

public AuthenticationTokenSettings()

Creates an instance of AuthenticationTokenSettings class.

Method Details

fromJson

public static AuthenticationTokenSettings fromJson(JsonReader jsonReader)

Reads an instance of AuthenticationTokenSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the AuthenticationTokenSettings.

getAccess

public List<BatchAccessScope> getAccess()

Get the access property: The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task.

Returns:

the access value.

setAccess

public AuthenticationTokenSettings setAccess(List<BatchAccessScope> access)

Set the access property: The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task.

Parameters:

access - the access value to set.

Returns:

the AuthenticationTokenSettings object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to