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

Class DescribeScheduledAuditResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iot.model.IotResponse
software.amazon.awssdk.services.iot.model.DescribeScheduledAuditResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeScheduledAuditResponse.Builder,DescribeScheduledAuditResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeScheduledAuditResponse extends IotResponse implements ToCopyableBuilder<DescribeScheduledAuditResponse.Builder,DescribeScheduledAuditResponse>

  • Method Details

    • frequency

      public final AuditFrequency frequency()

      How often the scheduled audit takes place, either one of 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 one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
      See Also:

    • frequencyAsString

      public final String frequencyAsString()

      How often the scheduled audit takes place, either one of 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 one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
      See Also:

    • dayOfMonth

      public final String dayOfMonth()

      The day of the month on which the scheduled audit takes place. This is will be 1 through 31 or LAST. 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 takes place. This is will be 1 through 31 or LAST. 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 takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.

      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 one of SUN, MON, TUE, WED, THU, FRI, or SAT.
      See Also:

    • dayOfWeekAsString

      public final String dayOfWeekAsString()

      The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.

      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 one of SUN, MON, TUE, WED, THU, FRI, or SAT.
      See Also:

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

    • toBuilder

      public DescribeScheduledAuditResponse.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<DescribeScheduledAuditResponse.Builder,DescribeScheduledAuditResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeScheduledAuditResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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