CreateScheduledAuditRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iot.model.IotRequest
    - - software.amazon.awssdk.services.iot.model.CreateScheduledAuditRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateScheduledAuditRequest.Builder,CreateScheduledAuditRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateScheduledAuditRequest
extends IotRequest
implements ToCopyableBuilder<CreateScheduledAuditRequest.Builder,CreateScheduledAuditRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateScheduledAuditRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateScheduledAuditRequest.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)`
`boolean`	`equalsBySdkFields(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)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTargetCheckNames()` Returns true if the TargetCheckNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`scheduledAuditName()` The name you want to give to the scheduled audit.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateScheduledAuditRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Metadata that can be used to manage the scheduled audit.
`List<String>`	`targetCheckNames()` Which checks are performed during the scheduled audit.
`CreateScheduledAuditRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, 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. Can be 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. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the system.
    
    See Also:
    
    AuditFrequency
  - frequencyAsString
```
public String frequencyAsString()
```
    How often the scheduled audit takes place. Can be 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. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The 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. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "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 takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "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 DayOfWeek dayOfWeek()
```
    The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "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 takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
    
    See Also:
    
    DayOfWeek
  - dayOfWeekAsString
```
public String dayOfWeekAsString()
```
    The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "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 takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
    
    See Also:
    
    DayOfWeek
  - hasTargetCheckNames
```
public boolean hasTargetCheckNames()
```
    Returns true if the TargetCheckNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - targetCheckNames
```
public 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.
    
    You can use hasTargetCheckNames() to see if a value was sent in this field.
    
    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 String scheduledAuditName()
```
    The name you want to give to the scheduled audit. (Max. 128 chars)
    
    Returns:
    
    The name you want to give to the scheduled audit. (Max. 128 chars)
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public List<Tag> tags()
```
    Metadata that can be used to manage the scheduled audit.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Metadata that can be used to manage the scheduled audit.
  - toBuilder
```
public CreateScheduledAuditRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateScheduledAuditRequest.Builder,CreateScheduledAuditRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
  - builder
```
public static CreateScheduledAuditRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateScheduledAuditRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateScheduledAuditRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

frequency

frequencyAsString

dayOfMonth

dayOfWeek

dayOfWeekAsString

hasTargetCheckNames

targetCheckNames

scheduledAuditName

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields