@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class IngestionJob extends Object implements Serializable, Cloneable, StructuredPojo
Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
This data type is used in the following API operations:
Constructor and Description |
---|
IngestionJob() |
Modifier and Type | Method and Description |
---|---|
IngestionJob |
clone() |
boolean |
equals(Object obj) |
String |
getDataSourceId()
The unique identifier of the ingested data source.
|
String |
getDescription()
The description of the ingestion job.
|
List<String> |
getFailureReasons()
A list of reasons that the ingestion job failed.
|
String |
getIngestionJobId()
The unique identifier of the ingestion job.
|
String |
getKnowledgeBaseId()
The unique identifier of the knowledge base to which the data source is being added.
|
Date |
getStartedAt()
The time at which the ingestion job started.
|
IngestionJobStatistics |
getStatistics()
Contains statistics about the ingestion job.
|
String |
getStatus()
The status of the ingestion job.
|
Date |
getUpdatedAt()
The time at which the ingestion job was last updated.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDataSourceId(String dataSourceId)
The unique identifier of the ingested data source.
|
void |
setDescription(String description)
The description of the ingestion job.
|
void |
setFailureReasons(Collection<String> failureReasons)
A list of reasons that the ingestion job failed.
|
void |
setIngestionJobId(String ingestionJobId)
The unique identifier of the ingestion job.
|
void |
setKnowledgeBaseId(String knowledgeBaseId)
The unique identifier of the knowledge base to which the data source is being added.
|
void |
setStartedAt(Date startedAt)
The time at which the ingestion job started.
|
void |
setStatistics(IngestionJobStatistics statistics)
Contains statistics about the ingestion job.
|
void |
setStatus(String status)
The status of the ingestion job.
|
void |
setUpdatedAt(Date updatedAt)
The time at which the ingestion job was last updated.
|
String |
toString()
Returns a string representation of this object.
|
IngestionJob |
withDataSourceId(String dataSourceId)
The unique identifier of the ingested data source.
|
IngestionJob |
withDescription(String description)
The description of the ingestion job.
|
IngestionJob |
withFailureReasons(Collection<String> failureReasons)
A list of reasons that the ingestion job failed.
|
IngestionJob |
withFailureReasons(String... failureReasons)
A list of reasons that the ingestion job failed.
|
IngestionJob |
withIngestionJobId(String ingestionJobId)
The unique identifier of the ingestion job.
|
IngestionJob |
withKnowledgeBaseId(String knowledgeBaseId)
The unique identifier of the knowledge base to which the data source is being added.
|
IngestionJob |
withStartedAt(Date startedAt)
The time at which the ingestion job started.
|
IngestionJob |
withStatistics(IngestionJobStatistics statistics)
Contains statistics about the ingestion job.
|
IngestionJob |
withStatus(IngestionJobStatus status)
The status of the ingestion job.
|
IngestionJob |
withStatus(String status)
The status of the ingestion job.
|
IngestionJob |
withUpdatedAt(Date updatedAt)
The time at which the ingestion job was last updated.
|
public void setDataSourceId(String dataSourceId)
The unique identifier of the ingested data source.
dataSourceId
- The unique identifier of the ingested data source.public String getDataSourceId()
The unique identifier of the ingested data source.
public IngestionJob withDataSourceId(String dataSourceId)
The unique identifier of the ingested data source.
dataSourceId
- The unique identifier of the ingested data source.public void setDescription(String description)
The description of the ingestion job.
description
- The description of the ingestion job.public String getDescription()
The description of the ingestion job.
public IngestionJob withDescription(String description)
The description of the ingestion job.
description
- The description of the ingestion job.public List<String> getFailureReasons()
A list of reasons that the ingestion job failed.
public void setFailureReasons(Collection<String> failureReasons)
A list of reasons that the ingestion job failed.
failureReasons
- A list of reasons that the ingestion job failed.public IngestionJob withFailureReasons(String... failureReasons)
A list of reasons that the ingestion job failed.
NOTE: This method appends the values to the existing list (if any). Use
setFailureReasons(java.util.Collection)
or withFailureReasons(java.util.Collection)
if you want
to override the existing values.
failureReasons
- A list of reasons that the ingestion job failed.public IngestionJob withFailureReasons(Collection<String> failureReasons)
A list of reasons that the ingestion job failed.
failureReasons
- A list of reasons that the ingestion job failed.public void setIngestionJobId(String ingestionJobId)
The unique identifier of the ingestion job.
ingestionJobId
- The unique identifier of the ingestion job.public String getIngestionJobId()
The unique identifier of the ingestion job.
public IngestionJob withIngestionJobId(String ingestionJobId)
The unique identifier of the ingestion job.
ingestionJobId
- The unique identifier of the ingestion job.public void setKnowledgeBaseId(String knowledgeBaseId)
The unique identifier of the knowledge base to which the data source is being added.
knowledgeBaseId
- The unique identifier of the knowledge base to which the data source is being added.public String getKnowledgeBaseId()
The unique identifier of the knowledge base to which the data source is being added.
public IngestionJob withKnowledgeBaseId(String knowledgeBaseId)
The unique identifier of the knowledge base to which the data source is being added.
knowledgeBaseId
- The unique identifier of the knowledge base to which the data source is being added.public void setStartedAt(Date startedAt)
The time at which the ingestion job started.
startedAt
- The time at which the ingestion job started.public Date getStartedAt()
The time at which the ingestion job started.
public IngestionJob withStartedAt(Date startedAt)
The time at which the ingestion job started.
startedAt
- The time at which the ingestion job started.public void setStatistics(IngestionJobStatistics statistics)
Contains statistics about the ingestion job.
statistics
- Contains statistics about the ingestion job.public IngestionJobStatistics getStatistics()
Contains statistics about the ingestion job.
public IngestionJob withStatistics(IngestionJobStatistics statistics)
Contains statistics about the ingestion job.
statistics
- Contains statistics about the ingestion job.public void setStatus(String status)
The status of the ingestion job.
status
- The status of the ingestion job.IngestionJobStatus
public String getStatus()
The status of the ingestion job.
IngestionJobStatus
public IngestionJob withStatus(String status)
The status of the ingestion job.
status
- The status of the ingestion job.IngestionJobStatus
public IngestionJob withStatus(IngestionJobStatus status)
The status of the ingestion job.
status
- The status of the ingestion job.IngestionJobStatus
public void setUpdatedAt(Date updatedAt)
The time at which the ingestion job was last updated.
updatedAt
- The time at which the ingestion job was last updated.public Date getUpdatedAt()
The time at which the ingestion job was last updated.
public IngestionJob withUpdatedAt(Date updatedAt)
The time at which the ingestion job was last updated.
updatedAt
- The time at which the ingestion job was last updated.public String toString()
toString
in class Object
Object.toString()
public IngestionJob clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.