Class DataSourceSummary

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

Summary information for a Amazon Kendra data source.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the data source.

      Returns:
      The name of the data source.

    • id

      public final String id()

      The identifier for the data source.

      Returns:
      The identifier for the data source.

    • type

      public final DataSourceType type()

      The type of the data source.

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

      Returns:
      The type of the data source.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the data source.

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

      Returns:
      The type of the data source.
      See Also:

    • createdAt

      public final Instant createdAt()

      The Unix timestamp when the data source connector was created.

      Returns:
      The Unix timestamp when the data source connector was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp when the data source connector was last updated.

      Returns:
      The Unix timestamp when the data source connector was last updated.

    • status

      public final DataSourceStatus status()

      The status of the data source. When the status is ACTIVE the data source is ready to use.

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

      Returns:
      The status of the data source. When the status is ACTIVE the data source is ready to use.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the data source. When the status is ACTIVE the data source is ready to use.

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

      Returns:
      The status of the data source. When the status is ACTIVE the data source is ready to use.
      See Also:

    • languageCode

      public final String languageCode()

      The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

      Returns:
      The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

    • toBuilder

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

    • builder

      public static DataSourceSummary.Builder builder()

    • serializableBuilderClass

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