/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.iot.model; import java.io.Serializable; /** *
* Information about the scheduled audit. *
*/ public class ScheduledAuditMetadata implements Serializable { /** ** The name of the scheduled audit. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
*/
private String scheduledAuditName;
/**
*
* The ARN of the scheduled audit. *
*/ private String scheduledAuditArn; /** ** How often the scheduled audit occurs. *
*
* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
*/
private String frequency;
/**
*
* The day of the month on which the scheduled audit is run (if the
* frequency
is "MONTHLY"). If days 29-31 are specified, and
* the month does not have that many days, the audit takes place on the
* "LAST" day of the month.
*
* Constraints:
* Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
*/
private String dayOfMonth;
/**
*
* The day of the week on which the scheduled audit is run (if the
* frequency
is "WEEKLY" or "BIWEEKLY").
*
* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
*/
private String dayOfWeek;
/**
*
* The name of the scheduled audit. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
*
* @return
* The name of the scheduled audit. *
*/ public String getScheduledAuditName() { return scheduledAuditName; } /** ** The name of the scheduled audit. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
*
* @param scheduledAuditName
* The name of the scheduled audit. *
*/ public void setScheduledAuditName(String scheduledAuditName) { this.scheduledAuditName = scheduledAuditName; } /** ** The name of the scheduled audit. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
*
* @param scheduledAuditName
* The name of the scheduled audit. *
* @return A reference to this updated object so that method calls can be * chained together. */ public ScheduledAuditMetadata withScheduledAuditName(String scheduledAuditName) { this.scheduledAuditName = scheduledAuditName; return this; } /** ** The ARN of the scheduled audit. *
* * @return* The ARN of the scheduled audit. *
*/ public String getScheduledAuditArn() { return scheduledAuditArn; } /** ** The ARN of the scheduled audit. *
* * @param scheduledAuditArn* The ARN of the scheduled audit. *
*/ public void setScheduledAuditArn(String scheduledAuditArn) { this.scheduledAuditArn = scheduledAuditArn; } /** ** The ARN of the scheduled audit. *
** Returns a reference to this object so that method calls can be chained * together. * * @param scheduledAuditArn
* The ARN of the scheduled audit. *
* @return A reference to this updated object so that method calls can be * chained together. */ public ScheduledAuditMetadata withScheduledAuditArn(String scheduledAuditArn) { this.scheduledAuditArn = scheduledAuditArn; return this; } /** ** How often the scheduled audit occurs. *
*
* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
*
* @return
* How often the scheduled audit occurs. *
* @see AuditFrequency */ public String getFrequency() { return frequency; } /** ** How often the scheduled audit occurs. *
*
* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
*
* @param frequency
* How often the scheduled audit occurs. *
* @see AuditFrequency */ public void setFrequency(String frequency) { this.frequency = frequency; } /** ** How often the scheduled audit occurs. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
*
* @param frequency
* How often the scheduled audit occurs. *
* @return A reference to this updated object so that method calls can be * chained together. * @see AuditFrequency */ public ScheduledAuditMetadata withFrequency(String frequency) { this.frequency = frequency; return this; } /** ** How often the scheduled audit occurs. *
*
* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
*
* @param frequency
* How often the scheduled audit occurs. *
* @see AuditFrequency */ public void setFrequency(AuditFrequency frequency) { this.frequency = frequency.toString(); } /** ** How often the scheduled audit occurs. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY
*
* @param frequency
* How often the scheduled audit occurs. *
* @return A reference to this updated object so that method calls can be * chained together. * @see AuditFrequency */ public ScheduledAuditMetadata withFrequency(AuditFrequency frequency) { this.frequency = frequency.toString(); return this; } /** *
* The day of the month on which the scheduled audit is run (if the
* frequency
is "MONTHLY"). If days 29-31 are specified, and
* the month does not have that many days, the audit takes place on the
* "LAST" day of the month.
*
* Constraints:
* Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
*
* @return
* The day of the month on which the scheduled audit is run (if the
* frequency
is "MONTHLY"). If days 29-31 are
* specified, and the month does not have that many days, the audit
* takes place on the "LAST" day of the month.
*
* The day of the month on which the scheduled audit is run (if the
* frequency
is "MONTHLY"). If days 29-31 are specified, and
* the month does not have that many days, the audit takes place on the
* "LAST" day of the month.
*
* Constraints:
* Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
*
* @param dayOfMonth
* The day of the month on which the scheduled audit is run (if
* the frequency
is "MONTHLY"). If days 29-31 are
* specified, and the month does not have that many days, the
* audit takes place on the "LAST" day of the month.
*
* The day of the month on which the scheduled audit is run (if the
* frequency
is "MONTHLY"). If days 29-31 are specified, and
* the month does not have that many days, the audit takes place on the
* "LAST" day of the month.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
*
* @param dayOfMonth
* The day of the month on which the scheduled audit is run (if
* the frequency
is "MONTHLY"). If days 29-31 are
* specified, and the month does not have that many days, the
* audit takes place on the "LAST" day of the month.
*
* The day of the week on which the scheduled audit is run (if the
* frequency
is "WEEKLY" or "BIWEEKLY").
*
* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
*
* @return
* The day of the week on which the scheduled audit is run (if the
* frequency
is "WEEKLY" or "BIWEEKLY").
*
* The day of the week on which the scheduled audit is run (if the
* frequency
is "WEEKLY" or "BIWEEKLY").
*
* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
*
* @param dayOfWeek
* The day of the week on which the scheduled audit is run (if
* the frequency
is "WEEKLY" or "BIWEEKLY").
*
* The day of the week on which the scheduled audit is run (if the
* frequency
is "WEEKLY" or "BIWEEKLY").
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
*
* @param dayOfWeek
* The day of the week on which the scheduled audit is run (if
* the frequency
is "WEEKLY" or "BIWEEKLY").
*
* The day of the week on which the scheduled audit is run (if the
* frequency
is "WEEKLY" or "BIWEEKLY").
*
* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
*
* @param dayOfWeek
* The day of the week on which the scheduled audit is run (if
* the frequency
is "WEEKLY" or "BIWEEKLY").
*
* The day of the week on which the scheduled audit is run (if the
* frequency
is "WEEKLY" or "BIWEEKLY").
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT
*
* @param dayOfWeek
* The day of the week on which the scheduled audit is run (if
* the frequency
is "WEEKLY" or "BIWEEKLY").
*