AccessReviewHistoryInstanceProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.authorization.fluent.models.AccessReviewHistoryInstanceProperties

Implements

public final class AccessReviewHistoryInstanceProperties
implements JsonSerializable<AccessReviewHistoryInstanceProperties>

Access Review History Definition Instance properties.

Constructor Summary

Constructor Description
AccessReviewHistoryInstanceProperties()

Creates an instance of AccessReviewHistoryInstanceProperties class.

Method Summary

Modifier and Type Method and Description
String displayName()

Get the displayName property: The display name for the parent history definition.

String downloadUri()

Get the downloadUri property: Uri which can be used to retrieve review history data.

OffsetDateTime expiration()

Get the expiration property: Date time when history data report expires and the associated data is deleted.

static AccessReviewHistoryInstanceProperties fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewHistoryInstanceProperties from the JsonReader.

OffsetDateTime fulfilledDateTime()

Get the fulfilledDateTime property: Date time when the history data report is scheduled to be generated.

OffsetDateTime reviewHistoryPeriodEndDateTime()

Get the reviewHistoryPeriodEndDateTime property: Date time used when selecting review data, all reviews included in data end on or before this date.

OffsetDateTime reviewHistoryPeriodStartDateTime()

Get the reviewHistoryPeriodStartDateTime property: Date time used when selecting review data, all reviews included in data start on or after this date.

OffsetDateTime runDateTime()

Get the runDateTime property: Date time when the history data report is scheduled to be generated.

AccessReviewHistoryDefinitionStatus status()

Get the status property: Status of the requested review history instance data.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

AccessReviewHistoryInstanceProperties withDisplayName(String displayName)

Set the displayName property: The display name for the parent history definition.

AccessReviewHistoryInstanceProperties withExpiration(OffsetDateTime expiration)

Set the expiration property: Date time when history data report expires and the associated data is deleted.

AccessReviewHistoryInstanceProperties withFulfilledDateTime(OffsetDateTime fulfilledDateTime)

Set the fulfilledDateTime property: Date time when the history data report is scheduled to be generated.

AccessReviewHistoryInstanceProperties withReviewHistoryPeriodEndDateTime(OffsetDateTime reviewHistoryPeriodEndDateTime)

Set the reviewHistoryPeriodEndDateTime property: Date time used when selecting review data, all reviews included in data end on or before this date.

AccessReviewHistoryInstanceProperties withReviewHistoryPeriodStartDateTime(OffsetDateTime reviewHistoryPeriodStartDateTime)

Set the reviewHistoryPeriodStartDateTime property: Date time used when selecting review data, all reviews included in data start on or after this date.

AccessReviewHistoryInstanceProperties withRunDateTime(OffsetDateTime runDateTime)

Set the runDateTime property: Date time when the history data report is scheduled to be generated.

Methods inherited from java.lang.Object

Constructor Details

AccessReviewHistoryInstanceProperties

public AccessReviewHistoryInstanceProperties()

Creates an instance of AccessReviewHistoryInstanceProperties class.

Method Details

displayName

public String displayName()

Get the displayName property: The display name for the parent history definition.

Returns:

the displayName value.

downloadUri

public String downloadUri()

Get the downloadUri property: Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.

Returns:

the downloadUri value.

expiration

public OffsetDateTime expiration()

Get the expiration property: Date time when history data report expires and the associated data is deleted.

Returns:

the expiration value.

fromJson

public static AccessReviewHistoryInstanceProperties fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewHistoryInstanceProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

fulfilledDateTime

public OffsetDateTime fulfilledDateTime()

Get the fulfilledDateTime property: Date time when the history data report is scheduled to be generated.

Returns:

the fulfilledDateTime value.

reviewHistoryPeriodEndDateTime

public OffsetDateTime reviewHistoryPeriodEndDateTime()

Get the reviewHistoryPeriodEndDateTime property: Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.

Returns:

the reviewHistoryPeriodEndDateTime value.

reviewHistoryPeriodStartDateTime

public OffsetDateTime reviewHistoryPeriodStartDateTime()

Get the reviewHistoryPeriodStartDateTime property: Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.

Returns:

the reviewHistoryPeriodStartDateTime value.

runDateTime

public OffsetDateTime runDateTime()

Get the runDateTime property: Date time when the history data report is scheduled to be generated.

Returns:

the runDateTime value.

status

public AccessReviewHistoryDefinitionStatus status()

Get the status property: Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired.

Returns:

the status value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withDisplayName

public AccessReviewHistoryInstanceProperties withDisplayName(String displayName)

Set the displayName property: The display name for the parent history definition.

Parameters:

displayName - the displayName value to set.

Returns:

the AccessReviewHistoryInstanceProperties object itself.

withExpiration

public AccessReviewHistoryInstanceProperties withExpiration(OffsetDateTime expiration)

Set the expiration property: Date time when history data report expires and the associated data is deleted.

Parameters:

expiration - the expiration value to set.

Returns:

the AccessReviewHistoryInstanceProperties object itself.

withFulfilledDateTime

public AccessReviewHistoryInstanceProperties withFulfilledDateTime(OffsetDateTime fulfilledDateTime)

Set the fulfilledDateTime property: Date time when the history data report is scheduled to be generated.

Parameters:

fulfilledDateTime - the fulfilledDateTime value to set.

Returns:

the AccessReviewHistoryInstanceProperties object itself.

withReviewHistoryPeriodEndDateTime

public AccessReviewHistoryInstanceProperties withReviewHistoryPeriodEndDateTime(OffsetDateTime reviewHistoryPeriodEndDateTime)

Set the reviewHistoryPeriodEndDateTime property: Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.

Parameters:

reviewHistoryPeriodEndDateTime - the reviewHistoryPeriodEndDateTime value to set.

Returns:

the AccessReviewHistoryInstanceProperties object itself.

withReviewHistoryPeriodStartDateTime

public AccessReviewHistoryInstanceProperties withReviewHistoryPeriodStartDateTime(OffsetDateTime reviewHistoryPeriodStartDateTime)

Set the reviewHistoryPeriodStartDateTime property: Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.

Parameters:

reviewHistoryPeriodStartDateTime - the reviewHistoryPeriodStartDateTime value to set.

Returns:

the AccessReviewHistoryInstanceProperties object itself.

withRunDateTime

public AccessReviewHistoryInstanceProperties withRunDateTime(OffsetDateTime runDateTime)

Set the runDateTime property: Date time when the history data report is scheduled to be generated.

Parameters:

runDateTime - the runDateTime value to set.

Returns:

the AccessReviewHistoryInstanceProperties object itself.

Applies to