Class ExtractionJobMetadata

java.lang.Object
software.amazon.awssdk.services.bedrockagentcore.model.ExtractionJobMetadata
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExtractionJobMetadata.Builder,ExtractionJobMetadata>
@Generated("software.amazon.awssdk:codegen") public final class ExtractionJobMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExtractionJobMetadata.Builder,ExtractionJobMetadata>

Metadata information associated with this extraction job.

See Also:

  • Method Details

    • jobID

      public final String jobID()

      The unique identifier for the extraction job.

      Returns:
      The unique identifier for the extraction job.

    • messages

      public final ExtractionJobMessages messages()

      The messages associated with the extraction job.

      Returns:
      The messages associated with the extraction job.

    • status

      public final ExtractionJobStatus status()

      The current status of the extraction job.

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

      Returns:
      The current status of the extraction job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the extraction job.

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

      Returns:
      The current status of the extraction job.
      See Also:

    • failureReason

      public final String failureReason()

      The cause of failure, if the job did not complete successfully.

      Returns:
      The cause of failure, if the job did not complete successfully.

    • strategyId

      public final String strategyId()

      The identifier of the memory strategy for this extraction job.

      Returns:
      The identifier of the memory strategy for this extraction job.

    • sessionId

      public final String sessionId()

      The identifier of the session for this extraction job.

      Returns:
      The identifier of the session for this extraction job.

    • actorId

      public final String actorId()

      The identifier of the actor for this extraction job.

      Returns:
      The identifier of the actor for this extraction job.

    • toBuilder

      public ExtractionJobMetadata.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<ExtractionJobMetadata.Builder,ExtractionJobMetadata>
      Returns:
      a builder for type T

    • builder

      public static ExtractionJobMetadata.Builder builder()

    • serializableBuilderClass

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