Package software.amazon.awssdk.services.kendra.model

Class DocumentInfo

java.lang.Object

software.amazon.awssdk.services.kendra.model.DocumentInfo

All Implemented Interfaces:

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

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

Identifies a document for which to retrieve status information

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentInfo.Builder

Method Summary

Modifier and Type	Method	Description
List<DocumentAttribute>	attributes()	Attributes that identify a specific version of a document to check.
static DocumentInfo.Builder	builder()
String	documentId()	The identifier of the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes()	For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentInfo.Builder>	serializableBuilderClass()
DocumentInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

documentId

public final String documentId()

The identifier of the document.

Returns:

The identifier of the document.

hasAttributes

public final boolean hasAttributes()

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

attributes

public final List<DocumentAttribute> attributes()

Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

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

Returns:

Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

toBuilder

public DocumentInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentInfo.Builder,DocumentInfo>

builder

public static DocumentInfo.Builder builder()

serializableBuilderClass

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