DescribeScheduledAuditResponse (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class DescribeScheduledAuditResponse
extends IotResponse
implements ToCopyableBuilder<DescribeScheduledAuditResponse.Builder,DescribeScheduledAuditResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeScheduledAuditResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeScheduledAuditResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`String`	`dayOfWeekAsString()` The day of the week on which the scheduled audit takes place.
`boolean`	`equals(Object obj)`
`AuditFrequency`	`frequency()` How often the scheduled audit takes place.
`String`	`frequencyAsString()` How often the scheduled audit takes place.
`<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()`
`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()`

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - frequency
```
public AuditFrequency frequency()
```
    How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual 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. One of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system.
    
    See Also:
    
    AuditFrequency
  - frequencyAsString
```
public String frequencyAsString()
```
    How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual 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. One of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system.
    
    See Also:
    
    AuditFrequency
  - dayOfMonth
```
public String dayOfMonth()
```
    The day of the month on which the scheduled audit takes place. 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. 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 DayOfWeek dayOfWeek()
```
    The day of the week on which the scheduled audit takes place. 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. One of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT".
    
    See Also:
    
    DayOfWeek
  - dayOfWeekAsString
```
public String dayOfWeekAsString()
```
    The day of the week on which the scheduled audit takes place. 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. One of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT".
    
    See Also:
    
    DayOfWeek
  - targetCheckNames
```
public List<String> targetCheckNames()
```
    Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.)
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.)
  - scheduledAuditName
```
public String scheduledAuditName()
```
    The name of the scheduled audit.
    
    Returns:
    
    The name of the scheduled audit.
  - scheduledAuditArn
```
public 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class DescribeScheduledAuditResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

frequency

frequencyAsString

dayOfMonth

dayOfWeek

dayOfWeekAsString

targetCheckNames

scheduledAuditName

scheduledAuditArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields