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

Implements

JsonSerializable<AccessReviewScheduleSettings>

public final class AccessReviewScheduleSettings
implements JsonSerializable<AccessReviewScheduleSettings>

Settings of an Access Review.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Boolean	autoApplyDecisionsEnabled() Get the autoApplyDecisionsEnabled property: Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled.
DefaultDecisionType	defaultDecision() Get the defaultDecision property: This specifies the behavior for the autoReview feature when an access review completes.
Boolean	defaultDecisionEnabled() Get the defaultDecisionEnabled property: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
OffsetDateTime	endDate() Get the endDate property: The DateTime when the review is scheduled to end.
static AccessReviewScheduleSettings	fromJson(JsonReader jsonReader) Reads an instance of AccessReviewScheduleSettings from the JsonReader.
Integer	instanceDurationInDays() Get the instanceDurationInDays property: The duration in days for an instance.
Integer	interval() Get the interval property: The interval for recurrence.
Boolean	justificationRequiredOnApproval() Get the justificationRequiredOnApproval property: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
Boolean	mailNotificationsEnabled() Get the mailNotificationsEnabled property: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
Integer	numberOfOccurrences() Get the numberOfOccurrences property: The number of times to repeat the access review.
Duration	recommendationLookBackDuration() Get the recommendationLookBackDuration property: Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default.
Boolean	recommendationsEnabled() Get the recommendationsEnabled property: Flag to indicate whether showing recommendations to reviewers is enabled.
Boolean	reminderNotificationsEnabled() Get the reminderNotificationsEnabled property: Flag to indicate whether sending reminder emails to reviewers are enabled.
OffsetDateTime	startDate() Get the startDate property: The DateTime when the review is scheduled to be start.
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.
void	validate() Validates the instance.
AccessReviewScheduleSettings	withAutoApplyDecisionsEnabled(Boolean autoApplyDecisionsEnabled) Set the autoApplyDecisionsEnabled property: Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled.
AccessReviewScheduleSettings	withDefaultDecision(DefaultDecisionType defaultDecision) Set the defaultDecision property: This specifies the behavior for the autoReview feature when an access review completes.
AccessReviewScheduleSettings	withDefaultDecisionEnabled(Boolean defaultDecisionEnabled) Set the defaultDecisionEnabled property: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
AccessReviewScheduleSettings	withEndDate(OffsetDateTime endDate) Set the endDate property: The DateTime when the review is scheduled to end.
AccessReviewScheduleSettings	withInstanceDurationInDays(Integer instanceDurationInDays) Set the instanceDurationInDays property: The duration in days for an instance.
AccessReviewScheduleSettings	withInterval(Integer interval) Set the interval property: The interval for recurrence.
AccessReviewScheduleSettings	withJustificationRequiredOnApproval(Boolean justificationRequiredOnApproval) Set the justificationRequiredOnApproval property: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
AccessReviewScheduleSettings	withMailNotificationsEnabled(Boolean mailNotificationsEnabled) Set the mailNotificationsEnabled property: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
AccessReviewScheduleSettings	withNumberOfOccurrences(Integer numberOfOccurrences) Set the numberOfOccurrences property: The number of times to repeat the access review.
AccessReviewScheduleSettings	withRecommendationLookBackDuration(Duration recommendationLookBackDuration) Set the recommendationLookBackDuration property: Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default.
AccessReviewScheduleSettings	withRecommendationsEnabled(Boolean recommendationsEnabled) Set the recommendationsEnabled property: Flag to indicate whether showing recommendations to reviewers is enabled.
AccessReviewScheduleSettings	withReminderNotificationsEnabled(Boolean reminderNotificationsEnabled) Set the reminderNotificationsEnabled property: Flag to indicate whether sending reminder emails to reviewers are enabled.
AccessReviewScheduleSettings	withStartDate(OffsetDateTime startDate) Set the startDate property: The DateTime when the review is scheduled to be start.
AccessReviewScheduleSettings	withType(AccessReviewRecurrencePatternType type) Set the type property: The recurrence type : weekly, monthly, etc.
AccessReviewScheduleSettings	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

AccessReviewScheduleSettings

public AccessReviewScheduleSettings()

Creates an instance of AccessReviewScheduleSettings class.

Method Details

autoApplyDecisionsEnabled

public Boolean autoApplyDecisionsEnabled()

Get the autoApplyDecisionsEnabled property: Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

Returns:

the autoApplyDecisionsEnabled value.

defaultDecision

public DefaultDecisionType defaultDecision()

Get the defaultDecision property: This specifies the behavior for the autoReview feature when an access review completes.

Returns:

the defaultDecision value.

defaultDecisionEnabled

public Boolean defaultDecisionEnabled()

Get the defaultDecisionEnabled property: Flag to indicate whether reviewers are required to provide a justification when reviewing access.

Returns:

the defaultDecisionEnabled 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 AccessReviewScheduleSettings fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewScheduleSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

instanceDurationInDays

public Integer instanceDurationInDays()

Get the instanceDurationInDays property: The duration in days for an instance.

Returns:

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

justificationRequiredOnApproval

public Boolean justificationRequiredOnApproval()

Get the justificationRequiredOnApproval property: Flag to indicate whether the reviewer is required to pass justification when recording a decision.

Returns:

the justificationRequiredOnApproval value.

mailNotificationsEnabled

public Boolean mailNotificationsEnabled()

Get the mailNotificationsEnabled property: Flag to indicate whether sending mails to reviewers and the review creator is enabled.

Returns:

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

recommendationLookBackDuration

public Duration recommendationLookBackDuration()

Get the recommendationLookBackDuration property: Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO\_8601\#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).

Returns:

the recommendationLookBackDuration value.

recommendationsEnabled

public Boolean recommendationsEnabled()

Get the recommendationsEnabled property: Flag to indicate whether showing recommendations to reviewers is enabled.

Returns:

the recommendationsEnabled value.

reminderNotificationsEnabled

public Boolean reminderNotificationsEnabled()

Get the reminderNotificationsEnabled property: Flag to indicate whether sending reminder emails to reviewers are enabled.

Returns:

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

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.

validate

public void validate()

Validates the instance.

withAutoApplyDecisionsEnabled

public AccessReviewScheduleSettings withAutoApplyDecisionsEnabled(Boolean autoApplyDecisionsEnabled)

Set the autoApplyDecisionsEnabled property: Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

Parameters:

autoApplyDecisionsEnabled - the autoApplyDecisionsEnabled value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withDefaultDecision

public AccessReviewScheduleSettings withDefaultDecision(DefaultDecisionType defaultDecision)

Set the defaultDecision property: This specifies the behavior for the autoReview feature when an access review completes.

Parameters:

defaultDecision - the defaultDecision value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withDefaultDecisionEnabled

public AccessReviewScheduleSettings withDefaultDecisionEnabled(Boolean defaultDecisionEnabled)

Set the defaultDecisionEnabled property: Flag to indicate whether reviewers are required to provide a justification when reviewing access.

Parameters:

defaultDecisionEnabled - the defaultDecisionEnabled value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withEndDate

public AccessReviewScheduleSettings 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 AccessReviewScheduleSettings object itself.

withInstanceDurationInDays

public AccessReviewScheduleSettings withInstanceDurationInDays(Integer instanceDurationInDays)

Set the instanceDurationInDays property: The duration in days for an instance.

Parameters:

instanceDurationInDays - the instanceDurationInDays value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withInterval

public AccessReviewScheduleSettings 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 AccessReviewScheduleSettings object itself.

withJustificationRequiredOnApproval

public AccessReviewScheduleSettings withJustificationRequiredOnApproval(Boolean justificationRequiredOnApproval)

Set the justificationRequiredOnApproval property: Flag to indicate whether the reviewer is required to pass justification when recording a decision.

Parameters:

justificationRequiredOnApproval - the justificationRequiredOnApproval value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withMailNotificationsEnabled

public AccessReviewScheduleSettings withMailNotificationsEnabled(Boolean mailNotificationsEnabled)

Set the mailNotificationsEnabled property: Flag to indicate whether sending mails to reviewers and the review creator is enabled.

Parameters:

mailNotificationsEnabled - the mailNotificationsEnabled value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withNumberOfOccurrences

public AccessReviewScheduleSettings 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 AccessReviewScheduleSettings object itself.

withRecommendationLookBackDuration

public AccessReviewScheduleSettings withRecommendationLookBackDuration(Duration recommendationLookBackDuration)

Set the recommendationLookBackDuration property: Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO\_8601\#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).

Parameters:

recommendationLookBackDuration - the recommendationLookBackDuration value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withRecommendationsEnabled

public AccessReviewScheduleSettings withRecommendationsEnabled(Boolean recommendationsEnabled)

Set the recommendationsEnabled property: Flag to indicate whether showing recommendations to reviewers is enabled.

Parameters:

recommendationsEnabled - the recommendationsEnabled value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withReminderNotificationsEnabled

public AccessReviewScheduleSettings withReminderNotificationsEnabled(Boolean reminderNotificationsEnabled)

Set the reminderNotificationsEnabled property: Flag to indicate whether sending reminder emails to reviewers are enabled.

Parameters:

reminderNotificationsEnabled - the reminderNotificationsEnabled value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withStartDate

public AccessReviewScheduleSettings 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 AccessReviewScheduleSettings object itself.

withType

public AccessReviewScheduleSettings withType(AccessReviewRecurrencePatternType type)

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

Parameters:

type - the type value to set.

Returns:

the AccessReviewScheduleSettings object itself.

withTypeRangeType

public AccessReviewScheduleSettings 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 AccessReviewScheduleSettings object itself.