Package software.amazon.awssdk.services.lookoutequipment.model

Class IngestedFilesSummary

java.lang.Object

software.amazon.awssdk.services.lookoutequipment.model.IngestedFilesSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IngestedFilesSummary.Builder,IngestedFilesSummary>

@Generated("software.amazon.awssdk:codegen")
public final class IngestedFilesSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IngestedFilesSummary.Builder,IngestedFilesSummary>

Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IngestedFilesSummary.Builder

Method Summary

Modifier and Type	Method	Description
static IngestedFilesSummary.Builder	builder()
List<S3Object>	discardedFiles()	Indicates the number of files that were discarded.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDiscardedFiles()	For responses, this returns true if the service returned a value for the DiscardedFiles property.
int	hashCode()
Integer	ingestedNumberOfFiles()	Indicates the number of files that were successfully ingested.
List<SdkField<?>>	sdkFields()
static Class<? extends IngestedFilesSummary.Builder>	serializableBuilderClass()
IngestedFilesSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	totalNumberOfFiles()	Indicates the total number of files that were submitted for ingestion.

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

totalNumberOfFiles

public final Integer totalNumberOfFiles()

Indicates the total number of files that were submitted for ingestion.

Returns:

Indicates the total number of files that were submitted for ingestion.

ingestedNumberOfFiles

public final Integer ingestedNumberOfFiles()

Indicates the number of files that were successfully ingested.

Returns:

Indicates the number of files that were successfully ingested.

hasDiscardedFiles

public final boolean hasDiscardedFiles()

For responses, this returns true if the service returned a value for the DiscardedFiles 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.

discardedFiles

public final List<S3Object> discardedFiles()

Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.

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

Returns:

Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.

toBuilder

public IngestedFilesSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IngestedFilesSummary.Builder,IngestedFilesSummary>

builder

public static IngestedFilesSummary.Builder builder()

serializableBuilderClass

public static Class<? extends IngestedFilesSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo