Package software.amazon.awssdk.services.bedrockagent.model

Class IngestionJob

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.IngestionJob

All Implemented Interfaces:

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

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

Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.

This data type is used in the following API operations:

• StartIngestionJob response

• GetIngestionJob response

• ListIngestionJob response

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IngestionJob.Builder

Method Summary

Modifier and Type	Method	Description
static IngestionJob.Builder	builder()
String	dataSourceId()	The unique identifier of the data source for the data ingestion job.
String	description()	The description of the data ingestion job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	failureReasons()	A list of reasons that the data ingestion job failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailureReasons()	For responses, this returns true if the service returned a value for the FailureReasons property.
int	hashCode()
String	ingestionJobId()	The unique identifier of the data ingestion job.
String	knowledgeBaseId()	The unique identifier of the knowledge for the data ingestion job.
List<SdkField<?>>	sdkFields()
static Class<? extends IngestionJob.Builder>	serializableBuilderClass()
Instant	startedAt()	The time the data ingestion job started.
IngestionJobStatistics	statistics()	Contains statistics about the data ingestion job.
IngestionJobStatus	status()	The status of the data ingestion job.
String	statusAsString()	The status of the data ingestion job.
IngestionJob.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The time the data ingestion job was last updated.

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

dataSourceId

public final String dataSourceId()

The unique identifier of the data source for the data ingestion job.

Returns:

The unique identifier of the data source for the data ingestion job.

description

public final String description()

The description of the data ingestion job.

Returns:

The description of the data ingestion job.

hasFailureReasons

public final boolean hasFailureReasons()

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

failureReasons

public final List<String> failureReasons()

A list of reasons that the data ingestion job failed.

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

Returns:

A list of reasons that the data ingestion job failed.

ingestionJobId

public final String ingestionJobId()

The unique identifier of the data ingestion job.

Returns:

The unique identifier of the data ingestion job.

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier of the knowledge for the data ingestion job.

Returns:

The unique identifier of the knowledge for the data ingestion job.

startedAt

public final Instant startedAt()

The time the data ingestion job started.

If you stop a data ingestion job, the startedAt time is the time the job was started before the job was stopped.

Returns:

The time the data ingestion job started.

If you stop a data ingestion job, the startedAt time is the time the job was started before the job was stopped.

statistics

public final IngestionJobStatistics statistics()

Contains statistics about the data ingestion job.

Returns:

Contains statistics about the data ingestion job.

status

public final IngestionJobStatus status()

The status of the data ingestion job.

If the service returns an enum value that is not available in the current SDK version, status will return IngestionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the data ingestion job.

See Also:

IngestionJobStatus

statusAsString

public final String statusAsString()

The status of the data ingestion job.

If the service returns an enum value that is not available in the current SDK version, status will return IngestionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the data ingestion job.

See Also:

IngestionJobStatus

updatedAt

public final Instant updatedAt()

The time the data ingestion job was last updated.

If you stop a data ingestion job, the updatedAt time is the time the job was stopped.

Returns:

The time the data ingestion job was last updated.

If you stop a data ingestion job, the updatedAt time is the time the job was stopped.

toBuilder

public IngestionJob.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IngestionJob.Builder,IngestionJob>

builder

public static IngestionJob.Builder builder()

serializableBuilderClass

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