@Generated(value="software.amazon.awssdk:codegen") public final class DescribeScheduledAuditResponse extends IotResponse implements ToCopyableBuilder<DescribeScheduledAuditResponse.Builder,DescribeScheduledAuditResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeScheduledAuditResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DescribeScheduledAuditResponse.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 one of
SUN, MON,
TUE, WED, THU, FRI, or SAT. |
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. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
AuditFrequency |
frequency()
How often the scheduled audit takes place, either one of
DAILY, WEEKLY,
BIWEEKLY, or MONTHLY. |
String |
frequencyAsString()
How often the scheduled audit takes place, either one of
DAILY, WEEKLY,
BIWEEKLY, or MONTHLY. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
int |
hashCode() |
boolean |
hasTargetCheckNames()
For responses, this returns true if the service returned a value for the TargetCheckNames property.
|
String |
scheduledAuditArn()
The ARN of the scheduled audit.
|
String |
scheduledAuditName()
The name of the scheduled audit.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeScheduledAuditResponse.Builder> |
serializableBuilderClass() |
List<String> |
targetCheckNames()
Which checks are performed during the scheduled audit.
|
DescribeScheduledAuditResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponsecopypublic 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().
DAILY, WEEKLY,
BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.AuditFrequencypublic 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().
DAILY, WEEKLY,
BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.AuditFrequencypublic 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.
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.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().
SUN,
MON, TUE, WED, THU, FRI, or
SAT.DayOfWeekpublic 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().
SUN,
MON, TUE, WED, THU, FRI, or
SAT.DayOfWeekpublic final boolean hasTargetCheckNames()
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.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.
DescribeAccountAuditConfiguration to see the list of all checks, including those that are
enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)public final String scheduledAuditName()
The name of the scheduled audit.
public final String scheduledAuditArn()
The ARN of the scheduled audit.
public DescribeScheduledAuditResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DescribeScheduledAuditResponse.Builder,DescribeScheduledAuditResponse>toBuilder in class AwsResponsepublic static DescribeScheduledAuditResponse.Builder builder()
public static Class<? extends DescribeScheduledAuditResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.