Class KnowledgeBaseIngestionSummary

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

A summary of an ingestion job for a knowledge base.

See Also:

  • Method Details

    • ingestionId

      public final String ingestionId()

      The unique identifier for the ingestion job.

      Returns:
      The unique identifier for the ingestion job.

    • ingestionStatus

      public final KbIngestionStatus ingestionStatus()

      The status of the ingestion job.

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

      Returns:
      The status of the ingestion job.
      See Also:

    • ingestionStatusAsString

      public final String ingestionStatusAsString()

      The status of the ingestion job.

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

      Returns:
      The status of the ingestion job.
      See Also:

    • startTime

      public final Instant startTime()

      The start time of the ingestion job.

      Returns:
      The start time of the ingestion job.

    • endTime

      public final Instant endTime()

      The end time of the ingestion job.

      Returns:
      The end time of the ingestion job.

    • toBuilder

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

    • builder

      public static KnowledgeBaseIngestionSummary.Builder builder()

    • serializableBuilderClass

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