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

Class DescribeScheduledAuditResponse

    • Method Detail

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

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

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

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

      • 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