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 the information of an ingestion job.

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()	Returns the value of the DataSourceId property for this object.
String	description()	Returns the value of the Description property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	failureReasons()	Returns the value of the FailureReasons property for this object.
<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()	Returns the value of the IngestionJobId property for this object.
String	knowledgeBaseId()	Returns the value of the KnowledgeBaseId property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends IngestionJob.Builder>	serializableBuilderClass()
Instant	startedAt()	Returns the value of the StartedAt property for this object.
IngestionJobStatistics	statistics()	Returns the value of the Statistics property for this object.
IngestionJobStatus	status()	Returns the value of the Status property for this object.
String	statusAsString()	Returns the value of the Status property for this object.
IngestionJob.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	Returns the value of the UpdatedAt property for 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

knowledgeBaseId

public final String knowledgeBaseId()

Returns the value of the KnowledgeBaseId property for this object.

Returns:

The value of the KnowledgeBaseId property for this object.

dataSourceId

public final String dataSourceId()

Returns the value of the DataSourceId property for this object.

Returns:

The value of the DataSourceId property for this object.

ingestionJobId

public final String ingestionJobId()

Returns the value of the IngestionJobId property for this object.

Returns:

The value of the IngestionJobId property for this object.

description

public final String description()

Returns the value of the Description property for this object.

Returns:

The value of the Description property for this object.

status

public final IngestionJobStatus status()

Returns the value of the Status property for this object.

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 value of the Status property for this object.

See Also:

IngestionJobStatus

statusAsString

public final String statusAsString()

Returns the value of the Status property for this object.

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 value of the Status property for this object.

See Also:

IngestionJobStatus

statistics

public final IngestionJobStatistics statistics()

Returns the value of the Statistics property for this object.

Returns:

The value of the Statistics property for this object.

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()

Returns the value of the FailureReasons property for this object.

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:

The value of the FailureReasons property for this object.

startedAt

public final Instant startedAt()

Returns the value of the StartedAt property for this object.

Returns:

The value of the StartedAt property for this object.

updatedAt

public final Instant updatedAt()

Returns the value of the UpdatedAt property for this object.

Returns:

The value of the UpdatedAt property for this object.

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