software.amazon.awssdk.services.iot.model

Class CreateScheduledAuditRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.CreateScheduledAuditRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateScheduledAuditRequest.Builder,CreateScheduledAuditRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateScheduledAuditRequest
extends IotRequest
implements ToCopyableBuilder<CreateScheduledAuditRequest.Builder,CreateScheduledAuditRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateScheduledAuditRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateScheduledAuditRequest.Builder	builder()
String	dayOfMonth() The day of the month on which the scheduled audit takes place.
DayOfWeek	dayOfWeek() The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT.
String	dayOfWeekAsString() The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
AuditFrequency	frequency() How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY.
String	frequencyAsString() How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasTargetCheckNames() For responses, this returns true if the service returned a value for the TargetCheckNames property.
String	scheduledAuditName() The name you want to give to the scheduled audit.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateScheduledAuditRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Metadata that can be used to manage the scheduled audit.
List<String>	targetCheckNames() Which checks are performed during the scheduled audit.
CreateScheduledAuditRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

frequency

public final 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.

If the service returns an enum value that is not available in the current SDK version, frequency will return AuditFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from frequencyAsString().

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

frequencyAsString

public final String frequencyAsString()

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

If the service returns an enum value that is not available in the current SDK version, frequency will return AuditFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from frequencyAsString().

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

dayOfMonth

public final 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:

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.

dayOfWeek

public final 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.

If the service returns an enum value that is not available in the current SDK version, dayOfWeek will return DayOfWeek.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dayOfWeekAsString().

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

dayOfWeekAsString

public final String dayOfWeekAsString()

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.

If the service returns an enum value that is not available in the current SDK version, dayOfWeek will return DayOfWeek.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dayOfWeekAsString().

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

hasTargetCheckNames

public final boolean hasTargetCheckNames()

For responses, this returns true if the service returned a value for the TargetCheckNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

targetCheckNames

public final List<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.)

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetCheckNames() method.

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

scheduledAuditName

public final String scheduledAuditName()

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

Returns:

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Metadata that can be used to manage the scheduled audit.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Metadata that can be used to manage the scheduled audit.

toBuilder

public CreateScheduledAuditRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateScheduledAuditRequest.Builder,CreateScheduledAuditRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CreateScheduledAuditRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateScheduledAuditRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo