AccessReviewHistoryDefinitionInner Class

Package:
com.azure.resourcemanager.authorization.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-authorization:2.54.0-beta.1

public final class AccessReviewHistoryDefinitionInner
extends ProxyResource

Access Review History Definition.

Method Summary

Modifier and Type Method and Description
OffsetDateTime createdDateTime()

Get the createdDateTime property: Date time when history definition was created.
List<AccessReviewResult> decisions()

Get the decisions property: Collection of review decisions which the history data should be filtered on.
String displayName()

Get the displayName property: The display name for the history definition.
OffsetDateTime endDate()

Get the endDate property: The DateTime when the review is scheduled to end.
static AccessReviewHistoryDefinitionInner fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewHistoryDefinitionInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
List<AccessReviewHistoryInstanceInner> instances()

Get the instances property: Set of access review history instances for this history definition.
Integer interval()

Get the interval property: The interval for recurrence.
String name()

Get the name property: The name of the resource.
Integer numberOfOccurrences()

Get the numberOfOccurrences property: The number of times to repeat the access review.
String principalId()

Get the principalId property: The identity id.
String principalName()

Get the principalName property: The identity display name.
AccessReviewActorIdentityType principalType()

Get the principalType property: The identity type : user/servicePrincipal.
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.
List<AccessReviewScope> scopes()

Get the scopes property: A collection of scopes used when selecting review history data.
OffsetDateTime startDate()

Get the startDate property: The DateTime when the review is scheduled to be start.
AccessReviewHistoryDefinitionStatus status()

Get the status property: This read-only field specifies the of the requested review history data.
SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
AccessReviewRecurrencePatternType typePropertiesType()

Get the type property: The recurrence type : weekly, monthly, etc.
AccessReviewRecurrenceRangeType typeRangeType()

Get the typeRangeType property: The recurrence range type.
String userPrincipalName()

Get the userPrincipalName property: The user principal name(if valid).
void validate()

Validates the instance.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createdDateTime

public OffsetDateTime createdDateTime()

Get the createdDateTime property: Date time when history definition was created.

Returns:

the createdDateTime value.

decisions

public List<AccessReviewResult> decisions()

Get the decisions property: Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.

Returns:

the decisions value.

displayName

public String displayName()

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

Returns:

the displayName value.

endDate

public OffsetDateTime endDate()

Get the endDate property: The DateTime when the review is scheduled to end. Required if type is endDate.

Returns:

the endDate value.

fromJson

public static AccessReviewHistoryDefinitionInner fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewHistoryDefinitionInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

AccessReviewHistoryDefinitionInner.id()

Returns:

the id value.

instances

public List<AccessReviewHistoryInstanceInner> instances()

Get the instances property: Set of access review history instances for this history definition.

Returns:

the instances value.

interval

public Integer interval()

Get the interval property: The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.

Returns:

the interval value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

AccessReviewHistoryDefinitionInner.name()

Returns:

the name value.

numberOfOccurrences

public Integer numberOfOccurrences()

Get the numberOfOccurrences property: The number of times to repeat the access review. Required and must be positive if type is numbered.

Returns:

the numberOfOccurrences value.

principalId

public String principalId()

Get the principalId property: The identity id.

Returns:

the principalId value.

principalName

public String principalName()

Get the principalName property: The identity display name.

Returns:

the principalName value.

principalType

public AccessReviewActorIdentityType principalType()

Get the principalType property: The identity type : user/servicePrincipal.

Returns:

the principalType 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.

scopes

public List<AccessReviewScope> scopes()

Get the scopes property: A collection of scopes used when selecting review history data.

Returns:

the scopes value.

startDate

public OffsetDateTime startDate()

Get the startDate property: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.

Returns:

the startDate value.

status

public AccessReviewHistoryDefinitionStatus status()

Get the status property: This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.

Returns:

the status value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AccessReviewHistoryDefinitionInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

AccessReviewHistoryDefinitionInner.type()

Returns:

the type value.

typePropertiesType

public AccessReviewRecurrencePatternType typePropertiesType()

Get the type property: The recurrence type : weekly, monthly, etc.

Returns:

the type value.

typeRangeType

public AccessReviewRecurrenceRangeType typeRangeType()

Get the typeRangeType property: The recurrence range type. The possible values are: endDate, noEnd, numbered.

Returns:

the typeRangeType value.

userPrincipalName

public String userPrincipalName()

Get the userPrincipalName property: The user principal name(if valid).

Returns:

the userPrincipalName value.

validate

public void validate()

Validates the instance.

Applies to