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:

See Also:

  • Method Details

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

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

    • ingestionJobId

      public final String ingestionJobId()

      The unique identifier of the data ingestion job.

      Returns:
      The unique identifier of the data ingestion job.

    • description

      public final String description()

      The description of the data ingestion job.

      Returns:
      The description of 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:

    • 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:

    • statistics

      public final IngestionJobStatistics statistics()

      Contains statistics about the data ingestion job.

      Returns:
      Contains statistics about 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.

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IngestionJob.Builder,IngestionJob>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.