com.amazonaws.services.iot.model

Class CreateScheduledAuditRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateScheduledAuditRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateScheduledAuditRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateScheduledAuditRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDayOfMonth() The day of the month on which the scheduled audit takes place.
java.lang.String	getDayOfWeek() The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT.
java.lang.String	getFrequency() How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY.
java.lang.String	getScheduledAuditName() The name you want to give to the scheduled audit.
java.util.List<Tag>	getTags() Metadata that can be used to manage the scheduled audit.
java.util.List<java.lang.String>	getTargetCheckNames() Which checks are performed during the scheduled audit.
int	hashCode()
void	setDayOfMonth(java.lang.String dayOfMonth) The day of the month on which the scheduled audit takes place.
void	setDayOfWeek(DayOfWeek dayOfWeek) The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT.
void	setDayOfWeek(java.lang.String dayOfWeek) The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT.
void	setFrequency(AuditFrequency frequency) How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY.
void	setFrequency(java.lang.String frequency) How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY.
void	setScheduledAuditName(java.lang.String scheduledAuditName) The name you want to give to the scheduled audit.
void	setTags(java.util.Collection<Tag> tags) Metadata that can be used to manage the scheduled audit.
void	setTargetCheckNames(java.util.Collection<java.lang.String> targetCheckNames) Which checks are performed during the scheduled audit.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateScheduledAuditRequest	withDayOfMonth(java.lang.String dayOfMonth) The day of the month on which the scheduled audit takes place.
CreateScheduledAuditRequest	withDayOfWeek(DayOfWeek dayOfWeek) The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT.
CreateScheduledAuditRequest	withDayOfWeek(java.lang.String dayOfWeek) The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT.
CreateScheduledAuditRequest	withFrequency(AuditFrequency frequency) How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY.
CreateScheduledAuditRequest	withFrequency(java.lang.String frequency) How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY.
CreateScheduledAuditRequest	withScheduledAuditName(java.lang.String scheduledAuditName) The name you want to give to the scheduled audit.
CreateScheduledAuditRequest	withTags(java.util.Collection<Tag> tags) Metadata that can be used to manage the scheduled audit.
CreateScheduledAuditRequest	withTags(Tag... tags) Metadata that can be used to manage the scheduled audit.
CreateScheduledAuditRequest	withTargetCheckNames(java.util.Collection<java.lang.String> targetCheckNames) Which checks are performed during the scheduled audit.
CreateScheduledAuditRequest	withTargetCheckNames(java.lang.String... targetCheckNames) Which checks are performed during the scheduled audit.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateScheduledAuditRequest

public CreateScheduledAuditRequest()

Method Detail

getFrequency

public java.lang.String getFrequency()

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

Returns:

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 Also:

AuditFrequency

setFrequency

public void setFrequency(java.lang.String 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

Parameters:

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 Also:

AuditFrequency

withFrequency

public CreateScheduledAuditRequest withFrequency(java.lang.String 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

Parameters:

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 updated object so that method calls can be chained together.

See Also:

AuditFrequency

setFrequency

public void setFrequency(AuditFrequency 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

Parameters:

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 Also:

AuditFrequency

withFrequency

public CreateScheduledAuditRequest withFrequency(AuditFrequency 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

Parameters:

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 updated object so that method calls can be chained together.

See Also:

AuditFrequency

getDayOfMonth

public java.lang.String getDayOfMonth()

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$

Returns:

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.

setDayOfMonth

public void setDayOfMonth(java.lang.String 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.

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

Parameters:

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.

withDayOfMonth

public CreateScheduledAuditRequest withDayOfMonth(java.lang.String 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.

Returns a reference to this object so that method calls can be chained together.

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getDayOfWeek

public java.lang.String getDayOfWeek()

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

Returns:

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 Also:

DayOfWeek

setDayOfWeek

public void setDayOfWeek(java.lang.String dayOfWeek)

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

Parameters:

dayOfWeek -

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 Also:

DayOfWeek

withDayOfWeek

public CreateScheduledAuditRequest withDayOfWeek(java.lang.String dayOfWeek)

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.

Returns a reference to this object so that method calls can be chained together.

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

Parameters:

dayOfWeek -

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DayOfWeek

setDayOfWeek

public void setDayOfWeek(DayOfWeek dayOfWeek)

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

Parameters:

dayOfWeek -

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 Also:

DayOfWeek

withDayOfWeek

public CreateScheduledAuditRequest withDayOfWeek(DayOfWeek dayOfWeek)

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.

Returns a reference to this object so that method calls can be chained together.

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

Parameters:

dayOfWeek -

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DayOfWeek

getTargetCheckNames

public java.util.List<java.lang.String> getTargetCheckNames()

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

Returns:

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

setTargetCheckNames

public void setTargetCheckNames(java.util.Collection<java.lang.String> 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.)

Parameters:

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

withTargetCheckNames

public CreateScheduledAuditRequest withTargetCheckNames(java.lang.String... 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.)

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withTargetCheckNames

public CreateScheduledAuditRequest withTargetCheckNames(java.util.Collection<java.lang.String> 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.)

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getScheduledAuditName

public java.lang.String getScheduledAuditName()

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

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

Returns:

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

setScheduledAuditName

public void setScheduledAuditName(java.lang.String scheduledAuditName)

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

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

Parameters:

scheduledAuditName -

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

withScheduledAuditName

public CreateScheduledAuditRequest withScheduledAuditName(java.lang.String 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_-]+

Parameters:

scheduledAuditName -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public java.util.List<Tag> getTags()

Metadata that can be used to manage the scheduled audit.

Returns:

Metadata that can be used to manage the scheduled audit.

setTags

public void setTags(java.util.Collection<Tag> tags)

Metadata that can be used to manage the scheduled audit.

Parameters:

tags -

Metadata that can be used to manage the scheduled audit.

withTags

public CreateScheduledAuditRequest withTags(Tag... 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.

Parameters:

tags -

Metadata that can be used to manage the scheduled audit.

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public CreateScheduledAuditRequest withTags(java.util.Collection<Tag> 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.

Parameters:

tags -

Metadata that can be used to manage the scheduled audit.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object