Class UpdateScheduledAuditRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateScheduledAuditRequest.Builder,
UpdateScheduledAuditRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The day of the month on which the scheduled audit takes place.final DayOfWeek
The day of the week on which the scheduled audit takes place.final String
The day of the week on which the scheduled audit takes place.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final AuditFrequency
How often the scheduled audit takes place, eitherDAILY
,WEEKLY
,BIWEEKLY
, orMONTHLY
.final String
How often the scheduled audit takes place, eitherDAILY
,WEEKLY
,BIWEEKLY
, orMONTHLY
.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TargetCheckNames property.final String
The name of the scheduled audit.static Class
<? extends UpdateScheduledAuditRequest.Builder> Which checks are performed during the scheduled audit.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
frequency
How often the scheduled audit takes place, either
DAILY
,WEEKLY
,BIWEEKLY
, orMONTHLY
. 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 returnAuditFrequency.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfrequencyAsString()
.- Returns:
- How often the scheduled audit takes place, either
DAILY
,WEEKLY
,BIWEEKLY
, orMONTHLY
. The start time of each audit is determined by the system. - See Also:
-
frequencyAsString
How often the scheduled audit takes place, either
DAILY
,WEEKLY
,BIWEEKLY
, orMONTHLY
. 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 returnAuditFrequency.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfrequencyAsString()
.- Returns:
- How often the scheduled audit takes place, either
DAILY
,WEEKLY
,BIWEEKLY
, orMONTHLY
. The start time of each audit is determined by the system. - See Also:
-
dayOfMonth
The day of the month on which the scheduled audit takes place. This can be
1
through31
orLAST
. This field is required if thefrequency
parameter is set toMONTHLY
. 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 can be
1
through31
orLAST
. This field is required if thefrequency
parameter is set toMONTHLY
. 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
The day of the week on which the scheduled audit takes place. This can be one of
SUN
,MON
,TUE
,WED
,THU
,FRI
, orSAT
. This field is required if the "frequency" parameter is set toWEEKLY
orBIWEEKLY
.If the service returns an enum value that is not available in the current SDK version,
dayOfWeek
will returnDayOfWeek.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdayOfWeekAsString()
.- Returns:
- The day of the week on which the scheduled audit takes place. This can be one of
SUN
,MON
,TUE
,WED
,THU
,FRI
, orSAT
. This field is required if the "frequency" parameter is set toWEEKLY
orBIWEEKLY
. - See Also:
-
dayOfWeekAsString
The day of the week on which the scheduled audit takes place. This can be one of
SUN
,MON
,TUE
,WED
,THU
,FRI
, orSAT
. This field is required if the "frequency" parameter is set toWEEKLY
orBIWEEKLY
.If the service returns an enum value that is not available in the current SDK version,
dayOfWeek
will returnDayOfWeek.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdayOfWeekAsString()
.- Returns:
- The day of the week on which the scheduled audit takes place. This can be one of
SUN
,MON
,TUE
,WED
,THU
,FRI
, orSAT
. This field is required if the "frequency" parameter is set toWEEKLY
orBIWEEKLY
. - 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 theisEmpty()
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
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 useUpdateAccountAuditConfiguration
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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)
-
scheduledAuditName
The name of the scheduled audit. (Max. 128 chars)
- Returns:
- The name of the scheduled audit. (Max. 128 chars)
-
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 interfaceToCopyableBuilder<UpdateScheduledAuditRequest.Builder,
UpdateScheduledAuditRequest> - Specified by:
toBuilder
in classIotRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-