/* * 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; import com.amazonaws.AmazonWebServiceRequest; /** *

* Creates a scheduled audit that is run at a specified time interval. *

* Requires permission to access the CreateScheduledAudit action. *

*/ public class CreateScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable { /** *

* How often the scheduled audit takes place, either DAILY, * WEEKLY, BIWEEKLY or MONTHLY. The * start time of each audit is determined by the system. *

* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY */ private String frequency; /** *

* The day of the month on which the scheduled audit takes place. This can * be "1" through "31" or "LAST". This field is required if the "frequency" * parameter is set to MONTHLY. If days 29 to 31 are specified, * and the month doesn't 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 takes place, either * SUN, MON, TUE, WED, * THU, FRI, or SAT. This field is * required if the frequency parameter is set to * WEEKLY or BIWEEKLY. *

* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT */ private String dayOfWeek; /** *

* Which checks are performed during the scheduled audit. Checks must be * enabled for your account. (Use * DescribeAccountAuditConfiguration to see the list of all * checks, including those that are enabled or use * UpdateAccountAuditConfiguration to select which checks are * enabled.) *

*/ private java.util.List targetCheckNames; /** *

* The name you want to give to the scheduled audit. (Max. 128 chars) *

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
*/ private String scheduledAuditName; /** *

* Metadata that can be used to manage the scheduled audit. *

*/ private java.util.List tags; /** *

* How often the scheduled audit takes place, either DAILY, * WEEKLY, BIWEEKLY or MONTHLY. The * start time of each audit is determined by the system. *

* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY * * @return

* How often the scheduled audit takes place, either * DAILY, WEEKLY, BIWEEKLY or * MONTHLY. The start time of each audit is determined * by the system. *

* @see AuditFrequency */ public String getFrequency() { return frequency; } /** *

* How often the scheduled audit takes place, either DAILY, * WEEKLY, BIWEEKLY or MONTHLY. The * start time of each audit is determined by the system. *

* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY * * @param frequency

* How often the scheduled audit takes place, either * DAILY, WEEKLY, BIWEEKLY * or MONTHLY. The start time of each audit is * determined by the system. *

* @see AuditFrequency */ public void setFrequency(String frequency) { this.frequency = frequency; } /** *

* How often the scheduled audit takes place, either DAILY, * WEEKLY, BIWEEKLY or MONTHLY. The * start time of each audit is determined by the system. *

* 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 takes place, either * DAILY, WEEKLY, BIWEEKLY * or MONTHLY. The start time of each audit is * determined by the system. *

* @return A reference to this updated object so that method calls can be * chained together. * @see AuditFrequency */ public CreateScheduledAuditRequest withFrequency(String frequency) { this.frequency = frequency; return this; } /** *

* How often the scheduled audit takes place, either DAILY, * WEEKLY, BIWEEKLY or MONTHLY. The * start time of each audit is determined by the system. *

* Constraints:
* Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY * * @param frequency

* How often the scheduled audit takes place, either * DAILY, WEEKLY, BIWEEKLY * or MONTHLY. The start time of each audit is * determined by the system. *

* @see AuditFrequency */ public void setFrequency(AuditFrequency frequency) { this.frequency = frequency.toString(); } /** *

* How often the scheduled audit takes place, either DAILY, * WEEKLY, BIWEEKLY or MONTHLY. The * start time of each audit is determined by the system. *

* 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 takes place, either * DAILY, WEEKLY, BIWEEKLY * or MONTHLY. The start time of each audit is * determined by the system. *

* @return A reference to this updated object so that method calls can be * chained together. * @see AuditFrequency */ public CreateScheduledAuditRequest withFrequency(AuditFrequency frequency) { this.frequency = frequency.toString(); return this; } /** *

* Constraints:
* Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
* * @return

* The day of the month on which the scheduled audit takes place. * This can be "1" through "31" or "LAST". This field is required if * the "frequency" parameter is set to MONTHLY. If days * 29 to 31 are specified, and the month doesn't have that many * days, the audit takes place on the LAST day of the * month. *

*/ public String getDayOfMonth() { return dayOfMonth; } /** *

* Constraints:
* Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$
* * @param dayOfMonth

* The day of the month on which the scheduled audit takes place. * This can be "1" through "31" or "LAST". This field is required * if the "frequency" parameter is set to MONTHLY. * If days 29 to 31 are specified, and the month doesn't have * that many days, the audit takes place on the LAST * day of the month. *

*/ public void setDayOfMonth(String dayOfMonth) { this.dayOfMonth = dayOfMonth; } /** *

* 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

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateScheduledAuditRequest withDayOfMonth(String dayOfMonth) { this.dayOfMonth = dayOfMonth; return this; } /** *

* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT * * @return

* The day of the week on which the scheduled audit takes place, * either SUN, MON, TUE, * WED, THU, FRI, or * SAT. This field is required if the * frequency parameter is set to WEEKLY or * BIWEEKLY. *

* @see DayOfWeek */ public String getDayOfWeek() { return dayOfWeek; } /** *

* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT * * @param dayOfWeek

* @see DayOfWeek */ public void setDayOfWeek(String dayOfWeek) { this.dayOfWeek = dayOfWeek; } /** *

* 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

* @return A reference to this updated object so that method calls can be * chained together. * @see DayOfWeek */ public CreateScheduledAuditRequest withDayOfWeek(String dayOfWeek) { this.dayOfWeek = dayOfWeek; return this; } /** *

* Constraints:
* Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT * * @param dayOfWeek

* @see DayOfWeek */ public void setDayOfWeek(DayOfWeek dayOfWeek) { this.dayOfWeek = dayOfWeek.toString(); } /** *

* 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

* @return A reference to this updated object so that method calls can be * chained together. * @see DayOfWeek */ public CreateScheduledAuditRequest withDayOfWeek(DayOfWeek dayOfWeek) { this.dayOfWeek = dayOfWeek.toString(); return this; } /** *

* * @return

* Which checks are performed during the scheduled audit. Checks * must be enabled for your account. (Use * DescribeAccountAuditConfiguration to see the list of * all checks, including those that are enabled or use * UpdateAccountAuditConfiguration to select which * checks are enabled.) *

*/ public java.util.List getTargetCheckNames() { return targetCheckNames; } /** *

* * @param targetCheckNames

* Which checks are performed during the scheduled audit. Checks * must be enabled for your account. (Use * DescribeAccountAuditConfiguration to see the list * of all checks, including those that are enabled or use * UpdateAccountAuditConfiguration to select which * checks are enabled.) *

*/ public void setTargetCheckNames(java.util.Collection targetCheckNames) { if (targetCheckNames == null) { this.targetCheckNames = null; return; } this.targetCheckNames = new java.util.ArrayList(targetCheckNames); } /** *

* Returns a reference to this object so that method calls can be chained * together. * * @param targetCheckNames

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateScheduledAuditRequest withTargetCheckNames(String... targetCheckNames) { if (getTargetCheckNames() == null) { this.targetCheckNames = new java.util.ArrayList(targetCheckNames.length); } for (String value : targetCheckNames) { this.targetCheckNames.add(value); } return this; } /** *

* Returns a reference to this object so that method calls can be chained * together. * * @param targetCheckNames

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateScheduledAuditRequest withTargetCheckNames( java.util.Collection targetCheckNames) { setTargetCheckNames(targetCheckNames); return this; } /** *

* The name you want to give to the scheduled audit. (Max. 128 chars) *

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
* * @return

* The name you want to give to the scheduled audit. (Max. 128 * chars) *

*/ public String getScheduledAuditName() { return scheduledAuditName; } /** *

* The name you want to give to the scheduled audit. (Max. 128 chars) *

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
* * @param scheduledAuditName

* The name you want to give to the scheduled audit. (Max. 128 * chars) *

*/ public void setScheduledAuditName(String scheduledAuditName) { this.scheduledAuditName = scheduledAuditName; } /** *

* The name you want to give to the scheduled audit. (Max. 128 chars) *

* 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 you want to give to the scheduled audit. (Max. 128 * chars) *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateScheduledAuditRequest withScheduledAuditName(String scheduledAuditName) { this.scheduledAuditName = scheduledAuditName; return this; } /** *

* Metadata that can be used to manage the scheduled audit. *

* * @return

* Metadata that can be used to manage the scheduled audit. *

*/ public java.util.List getTags() { return tags; } /** *

* Metadata that can be used to manage the scheduled audit. *

* * @param tags

* Metadata that can be used to manage the scheduled audit. *

*/ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new java.util.ArrayList(tags); } /** *

* Metadata that can be used to manage the scheduled audit. *

* Returns a reference to this object so that method calls can be chained * together. * * @param tags

* Metadata that can be used to manage the scheduled audit. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateScheduledAuditRequest withTags(Tag... tags) { if (getTags() == null) { this.tags = new java.util.ArrayList(tags.length); } for (Tag value : tags) { this.tags.add(value); } return this; } /** *

* Metadata that can be used to manage the scheduled audit. *

* Returns a reference to this object so that method calls can be chained * together. * * @param tags

* Metadata that can be used to manage the scheduled audit. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateScheduledAuditRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getFrequency() != null) sb.append("frequency: " + getFrequency() + ","); if (getDayOfMonth() != null) sb.append("dayOfMonth: " + getDayOfMonth() + ","); if (getDayOfWeek() != null) sb.append("dayOfWeek: " + getDayOfWeek() + ","); if (getTargetCheckNames() != null) sb.append("targetCheckNames: " + getTargetCheckNames() + ","); if (getScheduledAuditName() != null) sb.append("scheduledAuditName: " + getScheduledAuditName() + ","); if (getTags() != null) sb.append("tags: " + getTags()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getFrequency() == null) ? 0 : getFrequency().hashCode()); hashCode = prime * hashCode + ((getDayOfMonth() == null) ? 0 : getDayOfMonth().hashCode()); hashCode = prime * hashCode + ((getDayOfWeek() == null) ? 0 : getDayOfWeek().hashCode()); hashCode = prime * hashCode + ((getTargetCheckNames() == null) ? 0 : getTargetCheckNames().hashCode()); hashCode = prime * hashCode + ((getScheduledAuditName() == null) ? 0 : getScheduledAuditName().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateScheduledAuditRequest == false) return false; CreateScheduledAuditRequest other = (CreateScheduledAuditRequest) obj; if (other.getFrequency() == null ^ this.getFrequency() == null) return false; if (other.getFrequency() != null && other.getFrequency().equals(this.getFrequency()) == false) return false; if (other.getDayOfMonth() == null ^ this.getDayOfMonth() == null) return false; if (other.getDayOfMonth() != null && other.getDayOfMonth().equals(this.getDayOfMonth()) == false) return false; if (other.getDayOfWeek() == null ^ this.getDayOfWeek() == null) return false; if (other.getDayOfWeek() != null && other.getDayOfWeek().equals(this.getDayOfWeek()) == false) return false; if (other.getTargetCheckNames() == null ^ this.getTargetCheckNames() == null) return false; if (other.getTargetCheckNames() != null && other.getTargetCheckNames().equals(this.getTargetCheckNames()) == false) return false; if (other.getScheduledAuditName() == null ^ this.getScheduledAuditName() == null) return false; if (other.getScheduledAuditName() != null && other.getScheduledAuditName().equals(this.getScheduledAuditName()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } }