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:

  • Method Details

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

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

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

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

    • toBuilder

      public ScheduledAuditMetadata.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ScheduledAuditMetadata.Builder,ScheduledAuditMetadata>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.