Package software.amazon.awssdk.services.cloudwatchlogs.model

Class DescribeImportTaskBatchesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.DescribeImportTaskBatchesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeImportTaskBatchesRequest.Builder,DescribeImportTaskBatchesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeImportTaskBatchesRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<DescribeImportTaskBatchesRequest.Builder,DescribeImportTaskBatchesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeImportTaskBatchesRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<ImportStatus>	batchImportStatus()	Optional filter to list import batches by their status.
List<String>	batchImportStatusAsStrings()	Optional filter to list import batches by their status.
static DescribeImportTaskBatchesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBatchImportStatus()	For responses, this returns true if the service returned a value for the BatchImportStatus property.
int	hashCode()
String	importId()	The ID of the import task to get batch information for.
Integer	limit()	The maximum number of import batches to return in the response.
String	nextToken()	The pagination token for the next set of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeImportTaskBatchesRequest.Builder>	serializableBuilderClass()
DescribeImportTaskBatchesRequest.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

importId

public final String importId()

The ID of the import task to get batch information for.

Returns:

The ID of the import task to get batch information for.

batchImportStatus

public final List<ImportStatus> batchImportStatus()

Optional filter to list import batches by their status. Accepts multiple status values: IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

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 hasBatchImportStatus() method.

Returns:

Optional filter to list import batches by their status. Accepts multiple status values: IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

hasBatchImportStatus

public final boolean hasBatchImportStatus()

For responses, this returns true if the service returned a value for the BatchImportStatus property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

batchImportStatusAsStrings

public final List<String> batchImportStatusAsStrings()

Optional filter to list import batches by their status. Accepts multiple status values: IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

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 hasBatchImportStatus() method.

Returns:

Optional filter to list import batches by their status. Accepts multiple status values: IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

limit

public final Integer limit()

The maximum number of import batches to return in the response. Default: 10

Returns:

The maximum number of import batches to return in the response. Default: 10

nextToken

public final String nextToken()

The pagination token for the next set of results.

Returns:

The pagination token for the next set of results.

toBuilder

public DescribeImportTaskBatchesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeImportTaskBatchesRequest.Builder,DescribeImportTaskBatchesRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static DescribeImportTaskBatchesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeImportTaskBatchesRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo