ListAuditTasksRequest (AWS SDK for Java

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.ListAuditTasksRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListAuditTasksRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

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

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
  - startTime
```
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".
    
    Returns:
    
    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".
  - endTime
```
public final Instant endTime()
```
    The end of the time period.
    
    Returns:
    
    The end of the time period.
  - taskType
```
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().
    
    Returns:
    
    A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
    
    See Also:
    
    AuditTaskType
  - taskTypeAsString
```
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().
    
    Returns:
    
    A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
    
    See Also:
    
    AuditTaskType
  - taskStatus
```
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().
    
    Returns:
    
    A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
    
    See Also:
    
    AuditTaskStatus
  - taskStatusAsString
```
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().
    
    Returns:
    
    A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
    
    See Also:
    
    AuditTaskStatus
  - nextToken
```
public final String nextToken()
```
    The token for the next set of results.
    
    Returns:
    
    The token for the next set of results.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return at one time. The default is 25.
    
    Returns:
    
    The maximum number of results to return at one time. The default is 25.
  - toBuilder
```
public ListAuditTasksRequest.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<ListAuditTasksRequest.Builder,ListAuditTasksRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListAuditTasksRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListAuditTasksRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    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 an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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 final 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.

AWS SDK for Java API Reference - 2.17.11

Class ListAuditTasksRequest

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

startTime

endTime

taskType

taskTypeAsString

taskStatus

taskStatusAsString

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields