AccessReviewHistoryDefinitionProperties Class

Package:

com.azure.resourcemanager.authorization.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-authorization:2.54.0-beta.1

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

Implements

JsonSerializable<AccessReviewHistoryDefinitionProperties>

public final class AccessReviewHistoryDefinitionProperties
implements JsonSerializable<AccessReviewHistoryDefinitionProperties>

Access Review History Instances.

Constructor Summary

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

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 AccessReviewHistoryDefinitionProperties	fromJson(JsonReader jsonReader) Reads an instance of AccessReviewHistoryDefinitionProperties from the JsonReader.
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.
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.
JsonWriter	toJson(JsonWriter jsonWriter)
AccessReviewRecurrencePatternType	type() 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.
AccessReviewHistoryDefinitionProperties	withDecisions(List<AccessReviewResult> decisions) Set the decisions property: Collection of review decisions which the history data should be filtered on.
AccessReviewHistoryDefinitionProperties	withDisplayName(String displayName) Set the displayName property: The display name for the history definition.
AccessReviewHistoryDefinitionProperties	withEndDate(OffsetDateTime endDate) Set the endDate property: The DateTime when the review is scheduled to end.
AccessReviewHistoryDefinitionProperties	withInstances(List<AccessReviewHistoryInstanceInner> instances) Set the instances property: Set of access review history instances for this history definition.
AccessReviewHistoryDefinitionProperties	withInterval(Integer interval) Set the interval property: The interval for recurrence.
AccessReviewHistoryDefinitionProperties	withNumberOfOccurrences(Integer numberOfOccurrences) Set the numberOfOccurrences property: The number of times to repeat the access review.
AccessReviewHistoryDefinitionProperties	withScopes(List<AccessReviewScope> scopes) Set the scopes property: A collection of scopes used when selecting review history data.
AccessReviewHistoryDefinitionProperties	withStartDate(OffsetDateTime startDate) Set the startDate property: The DateTime when the review is scheduled to be start.
AccessReviewHistoryDefinitionProperties	withType(AccessReviewRecurrencePatternType type) Set the type property: The recurrence type : weekly, monthly, etc.
AccessReviewHistoryDefinitionProperties	withTypeRangeType(AccessReviewRecurrenceRangeType typeRangeType) Set the typeRangeType property: The recurrence range type.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AccessReviewHistoryDefinitionProperties

public AccessReviewHistoryDefinitionProperties()

Creates an instance of AccessReviewHistoryDefinitionProperties class.

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 AccessReviewHistoryDefinitionProperties fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewHistoryDefinitionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public AccessReviewRecurrencePatternType type()

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.

withDecisions

public AccessReviewHistoryDefinitionProperties withDecisions(List<AccessReviewResult> decisions)

Set 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.

Parameters:

decisions - the decisions value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withDisplayName

public AccessReviewHistoryDefinitionProperties withDisplayName(String displayName)

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

Parameters:

displayName - the displayName value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withEndDate

public AccessReviewHistoryDefinitionProperties withEndDate(OffsetDateTime endDate)

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

Parameters:

endDate - the endDate value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withInstances

public AccessReviewHistoryDefinitionProperties withInstances(List<AccessReviewHistoryInstanceInner> instances)

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

Parameters:

instances - the instances value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withInterval

public AccessReviewHistoryDefinitionProperties withInterval(Integer interval)

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

Parameters:

interval - the interval value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withNumberOfOccurrences

public AccessReviewHistoryDefinitionProperties withNumberOfOccurrences(Integer numberOfOccurrences)

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

Parameters:

numberOfOccurrences - the numberOfOccurrences value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withScopes

public AccessReviewHistoryDefinitionProperties withScopes(List<AccessReviewScope> scopes)

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

Parameters:

scopes - the scopes value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withStartDate

public AccessReviewHistoryDefinitionProperties withStartDate(OffsetDateTime startDate)

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

Parameters:

startDate - the startDate value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withType

public AccessReviewHistoryDefinitionProperties withType(AccessReviewRecurrencePatternType type)

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

Parameters:

type - the type value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.

withTypeRangeType

public AccessReviewHistoryDefinitionProperties withTypeRangeType(AccessReviewRecurrenceRangeType typeRangeType)

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

Parameters:

typeRangeType - the typeRangeType value to set.

Returns:

the AccessReviewHistoryDefinitionProperties object itself.