@Generated(value="software.amazon.awssdk:codegen") public final class ListAuditTasksRequest extends IotRequest implements ToCopyableBuilder<ListAuditTasksRequest.Builder,ListAuditTasksRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListAuditTasksRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ListAuditTasksRequest.Builder |
builder() |
Instant |
endTime()
The end of the time period.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
maxResults()
The maximum number of results to return at one time.
|
String |
nextToken()
The token for the next set of results.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListAuditTasksRequest.Builder> |
serializableBuilderClass() |
Instant |
startTime()
The beginning of the time period.
|
AuditTaskStatus |
taskStatus()
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS",
"COMPLETED", "FAILED", or "CANCELED".
|
String |
taskStatusAsString()
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS",
"COMPLETED", "FAILED", or "CANCELED".
|
AuditTaskType |
taskType()
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or
"SCHEDULED__AUDIT_TASK".
|
String |
taskTypeAsString()
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or
"SCHEDULED__AUDIT_TASK".
|
ListAuditTasksRequest.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.
|
overrideConfiguration
copy
public final Instant startTime()
The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
public final Instant endTime()
The end of the time period.
public final AuditTaskType taskType()
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
If the service returns an enum value that is not available in the current SDK version, taskType
will
return AuditTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
taskTypeAsString()
.
AuditTaskType
public final String taskTypeAsString()
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
If the service returns an enum value that is not available in the current SDK version, taskType
will
return AuditTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
taskTypeAsString()
.
AuditTaskType
public final AuditTaskStatus taskStatus()
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
If the service returns an enum value that is not available in the current SDK version, taskStatus
will
return AuditTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
taskStatusAsString()
.
AuditTaskStatus
public final String taskStatusAsString()
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
If the service returns an enum value that is not available in the current SDK version, taskStatus
will
return AuditTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
taskStatusAsString()
.
AuditTaskStatus
public final String nextToken()
The token for the next set of results.
public final Integer maxResults()
The maximum number of results to return at one time. The default is 25.
public ListAuditTasksRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListAuditTasksRequest.Builder,ListAuditTasksRequest>
toBuilder
in class IotRequest
public static ListAuditTasksRequest.Builder builder()
public static Class<? extends ListAuditTasksRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
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 SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.