Status (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.Status

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Status
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information about the status of documents submitted for indexing.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Status()

Constructors
Constructor and Description
`Status()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Status`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDocumentId()` The unique identifier of the document.
`String`	`getDocumentStatus()` The current status of a document.
`String`	`getFailureCode()` Indicates the source of the error.
`String`	`getFailureReason()` Provides detailed information about why the document couldn't be indexed.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDocumentId(String documentId)` The unique identifier of the document.
`void`	`setDocumentStatus(String documentStatus)` The current status of a document.
`void`	`setFailureCode(String failureCode)` Indicates the source of the error.
`void`	`setFailureReason(String failureReason)` Provides detailed information about why the document couldn't be indexed.
`String`	`toString()` Returns a string representation of this object.
`Status`	`withDocumentId(String documentId)` The unique identifier of the document.
`Status`	`withDocumentStatus(DocumentStatus documentStatus)` The current status of a document.
`Status`	`withDocumentStatus(String documentStatus)` The current status of a document.
`Status`	`withFailureCode(String failureCode)` Indicates the source of the error.
`Status`	`withFailureReason(String failureReason)` Provides detailed information about why the document couldn't be indexed.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Status
```
public Status()
```
- Method Detail
  - setDocumentId
```
public void setDocumentId(String documentId)
```
    The unique identifier of the document.
    
    Parameters:
    
    documentId - The unique identifier of the document.
  - getDocumentId
```
public String getDocumentId()
```
    The unique identifier of the document.
    
    Returns:
    
    The unique identifier of the document.
  - withDocumentId
```
public Status withDocumentId(String documentId)
```
    The unique identifier of the document.
    
    Parameters:
    
    documentId - The unique identifier of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentStatus
```
public void setDocumentStatus(String documentStatus)
```
    The current status of a document.
    
    If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
    
    Parameters:
    
    documentStatus - The current status of a document.
    
    If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
    
    See Also:
    
    DocumentStatus
  - getDocumentStatus
```
public String getDocumentStatus()
```
    The current status of a document.
    
    If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
    
    Returns:
    
    The current status of a document.
    
    If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
    
    See Also:
    
    DocumentStatus
  - withDocumentStatus
```
public Status withDocumentStatus(String documentStatus)
```
    The current status of a document.
    
    If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
    
    Parameters:
    
    documentStatus - The current status of a document.
    
    If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentStatus
  - withDocumentStatus
```
public Status withDocumentStatus(DocumentStatus documentStatus)
```
    The current status of a document.
    
    If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
    
    Parameters:
    
    documentStatus - The current status of a document.
    
    If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentStatus
  - setFailureCode
```
public void setFailureCode(String failureCode)
```
    Indicates the source of the error.
    
    Parameters:
    
    failureCode - Indicates the source of the error.
  - getFailureCode
```
public String getFailureCode()
```
    Indicates the source of the error.
    
    Returns:
    
    Indicates the source of the error.
  - withFailureCode
```
public Status withFailureCode(String failureCode)
```
    Indicates the source of the error.
    
    Parameters:
    
    failureCode - Indicates the source of the error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
    
    Parameters:
    
    failureReason - Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
  - getFailureReason
```
public String getFailureReason()
```
    Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
    
    Returns:
    
    Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
  - withFailureReason
```
public Status withFailureReason(String failureReason)
```
    Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
    
    Parameters:
    
    failureReason - Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
    
    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 Status 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.

Did this page help you?

Class Status

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Status

Method Detail

setDocumentId

getDocumentId

withDocumentId

setDocumentStatus

getDocumentStatus

withDocumentStatus

withDocumentStatus

setFailureCode

getFailureCode

withFailureCode

setFailureReason

getFailureReason

withFailureReason

toString

equals

hashCode

clone

marshall