Class IndexConfigurationSummary

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

Summary information on the configuration of an index.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the index.

      Returns:
      The name of the index.

    • id

      public final String id()

      A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

      Returns:
      A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

    • edition

      public final IndexEdition edition()

      Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

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

      Returns:
      Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
      See Also:

    • editionAsString

      public final String editionAsString()

      Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

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

      Returns:
      Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
      See Also:

    • createdAt

      public final Instant createdAt()

      The Unix timestamp when the index was created.

      Returns:
      The Unix timestamp when the index was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp when the index was last updated.

      Returns:
      The Unix timestamp when the index was last updated.

    • status

      public final IndexStatus status()

      The current status of the index. When the status is ACTIVE, the index is ready to search.

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

      Returns:
      The current status of the index. When the status is ACTIVE, the index is ready to search.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the index. When the status is ACTIVE, the index is ready to search.

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

      Returns:
      The current status of the index. When the status is ACTIVE, the index is ready to search.
      See Also:

    • toBuilder

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

    • builder

      public static IndexConfigurationSummary.Builder builder()

    • serializableBuilderClass

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