com.amazonaws.services.kendra.model

Class DocumentInfo

java.lang.Object

com.amazonaws.services.kendra.model.DocumentInfo

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentInfo
extends Object
implements Serializable, Cloneable, StructuredPojo

Identifies a document for which to retrieve status information

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentInfo()

Method Summary

Modifier and Type	Method and Description
DocumentInfo	clone()
boolean	equals(Object obj)
List<DocumentAttribute>	getAttributes() Attributes that identify a specific version of a document to check.
String	getDocumentId() The identifier of the document.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttributes(Collection<DocumentAttribute> attributes) Attributes that identify a specific version of a document to check.
void	setDocumentId(String documentId) The identifier of the document.
String	toString() Returns a string representation of this object.
DocumentInfo	withAttributes(Collection<DocumentAttribute> attributes) Attributes that identify a specific version of a document to check.
DocumentInfo	withAttributes(DocumentAttribute... attributes) Attributes that identify a specific version of a document to check.
DocumentInfo	withDocumentId(String documentId) The identifier of the document.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentInfo

public DocumentInfo()

Method Detail

setDocumentId

public void setDocumentId(String documentId)

The identifier of the document.

Parameters:

documentId - The identifier of the document.

getDocumentId

public String getDocumentId()

The identifier of the document.

Returns:

The identifier of the document.

withDocumentId

public DocumentInfo withDocumentId(String documentId)

The identifier of the document.

Parameters:

documentId - The identifier of the document.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAttributes

public List<DocumentAttribute> getAttributes()

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

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

setAttributes

public void setAttributes(Collection<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".

Parameters:

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

withAttributes

public DocumentInfo withAttributes(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".

NOTE: This method appends the values to the existing list (if any). Use setAttributes(java.util.Collection) or withAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withAttributes

public DocumentInfo withAttributes(Collection<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".

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DocumentInfo clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.