RosterProfile Class

Package:

com.azure.resourcemanager.labservices.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-labservices:1.0.0

• java.lang.Object
• • com.azure.resourcemanager.labservices.models.RosterProfile

Implements

JsonSerializable<RosterProfile>

public final class RosterProfile
implements JsonSerializable<RosterProfile>

The lab user list management profile.

Constructor Summary

Constructor	Description
RosterProfile()	Creates an instance of RosterProfile class.

Method Summary

Modifier and Type	Method and Description
String	activeDirectoryGroupId() Get the activeDirectoryGroupId property: The AAD group ID which this lab roster is populated from.
static RosterProfile	fromJson(JsonReader jsonReader) Reads an instance of RosterProfile from the JsonReader.
String	lmsInstance() Get the lmsInstance property: The base URI identifying the lms instance.
String	ltiClientId() Get the ltiClientId property: The unique id of the azure lab services tool in the lms.
String	ltiContextId() Get the ltiContextId property: The unique context identifier for the lab in the lms.
String	ltiRosterEndpoint() Get the ltiRosterEndpoint property: The uri of the names and roles service endpoint on the lms for the class attached to this lab.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
RosterProfile	withActiveDirectoryGroupId(String activeDirectoryGroupId) Set the activeDirectoryGroupId property: The AAD group ID which this lab roster is populated from.
RosterProfile	withLmsInstance(String lmsInstance) Set the lmsInstance property: The base URI identifying the lms instance.
RosterProfile	withLtiClientId(String ltiClientId) Set the ltiClientId property: The unique id of the azure lab services tool in the lms.
RosterProfile	withLtiContextId(String ltiContextId) Set the ltiContextId property: The unique context identifier for the lab in the lms.
RosterProfile	withLtiRosterEndpoint(String ltiRosterEndpoint) Set the ltiRosterEndpoint property: The uri of the names and roles service endpoint on the lms for the class attached to this lab.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RosterProfile

public RosterProfile()

Creates an instance of RosterProfile class.

Method Details

activeDirectoryGroupId

public String activeDirectoryGroupId()

Get the activeDirectoryGroupId property: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode.

Returns:

the activeDirectoryGroupId value.

fromJson

public static RosterProfile fromJson(JsonReader jsonReader)

Reads an instance of RosterProfile from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RosterProfile 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 RosterProfile.

lmsInstance

public String lmsInstance()

Get the lmsInstance property: The base URI identifying the lms instance.

Returns:

the lmsInstance value.

ltiClientId

public String ltiClientId()

Get the ltiClientId property: The unique id of the azure lab services tool in the lms.

Returns:

the ltiClientId value.

ltiContextId

public String ltiContextId()

Get the ltiContextId property: The unique context identifier for the lab in the lms.

Returns:

the ltiContextId value.

ltiRosterEndpoint

public String ltiRosterEndpoint()

Get the ltiRosterEndpoint property: The uri of the names and roles service endpoint on the lms for the class attached to this lab.

Returns:

the ltiRosterEndpoint value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withActiveDirectoryGroupId

public RosterProfile withActiveDirectoryGroupId(String activeDirectoryGroupId)

Set the activeDirectoryGroupId property: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode.

Parameters:

activeDirectoryGroupId - the activeDirectoryGroupId value to set.

Returns:

the RosterProfile object itself.

withLmsInstance

public RosterProfile withLmsInstance(String lmsInstance)

Set the lmsInstance property: The base URI identifying the lms instance.

Parameters:

lmsInstance - the lmsInstance value to set.

Returns:

the RosterProfile object itself.

withLtiClientId

public RosterProfile withLtiClientId(String ltiClientId)

Set the ltiClientId property: The unique id of the azure lab services tool in the lms.

Parameters:

ltiClientId - the ltiClientId value to set.

Returns:

the RosterProfile object itself.

withLtiContextId

public RosterProfile withLtiContextId(String ltiContextId)

Set the ltiContextId property: The unique context identifier for the lab in the lms.

Parameters:

ltiContextId - the ltiContextId value to set.

Returns:

the RosterProfile object itself.

withLtiRosterEndpoint

public RosterProfile withLtiRosterEndpoint(String ltiRosterEndpoint)

Set the ltiRosterEndpoint property: The uri of the names and roles service endpoint on the lms for the class attached to this lab.

Parameters:

ltiRosterEndpoint - the ltiRosterEndpoint value to set.

Returns:

the RosterProfile object itself.