Package software.amazon.awssdk.services.iot.model

Class ScheduledAuditMetadata

java.lang.Object

software.amazon.awssdk.services.iot.model.ScheduledAuditMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScheduledAuditMetadata.Builder,ScheduledAuditMetadata>

@Generated("software.amazon.awssdk:codegen")
public final class ScheduledAuditMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledAuditMetadata.Builder,ScheduledAuditMetadata>

Information about the scheduled audit.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScheduledAuditMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static ScheduledAuditMetadata.Builder	builder()
String	dayOfMonth()	The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY").
DayOfWeek	dayOfWeek()	The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
String	dayOfWeekAsString()	The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
AuditFrequency	frequency()	How often the scheduled audit occurs.
String	frequencyAsString()	How often the scheduled audit occurs.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	scheduledAuditArn()	The ARN of the scheduled audit.
String	scheduledAuditName()	The name of the scheduled audit.
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduledAuditMetadata.Builder>	serializableBuilderClass()
ScheduledAuditMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

scheduledAuditName

public final String scheduledAuditName()

The name of the scheduled audit.

Returns:

The name of the scheduled audit.

scheduledAuditArn

public final String scheduledAuditArn()

The ARN of the scheduled audit.

Returns:

The ARN of the scheduled audit.

frequency

public final AuditFrequency frequency()

How often the scheduled audit occurs.

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

See Also:

AuditFrequency

frequencyAsString

public final String frequencyAsString()

How often the scheduled audit occurs.

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

See Also:

AuditFrequency

dayOfMonth

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

Returns:

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.

dayOfWeek

public final DayOfWeek dayOfWeek()

The day of the week on which the scheduled audit is run (if the frequency is "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 is run (if the frequency is "WEEKLY" or "BIWEEKLY").

See Also:

DayOfWeek

dayOfWeekAsString

public final String dayOfWeekAsString()

The day of the week on which the scheduled audit is run (if the frequency is "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 is run (if the frequency is "WEEKLY" or "BIWEEKLY").

See Also:

DayOfWeek

toBuilder

public ScheduledAuditMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduledAuditMetadata.Builder,ScheduledAuditMetadata>

builder

public static ScheduledAuditMetadata.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo