Class IngestionStreamSummary

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

Summary information about an ingestion stream.

See Also:

  • Method Details

    • ingestionStreamId

      public final String ingestionStreamId()

      The unique identifier of the ingestion stream.

      Returns:
      The unique identifier of the ingestion stream.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the ingestion stream.

      Returns:
      The Amazon Resource Name (ARN) of the ingestion stream.

    • ingestionStreamName

      public final String ingestionStreamName()

      The name of the ingestion stream.

      Returns:
      The name of the ingestion stream.

    • indexName

      public final String indexName()

      The name of the index that documents are ingested into.

      Returns:
      The name of the index that documents are ingested into.

    • status

      public final IngestionStreamStatus status()

      The current lifecycle status of the ingestion stream.

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

      Returns:
      The current lifecycle status of the ingestion stream.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current lifecycle status of the ingestion stream.

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

      Returns:
      The current lifecycle status of the ingestion stream.
      See Also:

    • createdAt

      public final Instant createdAt()

      The date and time when the ingestion stream was created.

      Returns:
      The date and time when the ingestion stream was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time when the ingestion stream was last updated.

      Returns:
      The date and time when the ingestion stream was last updated.

    • toBuilder

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

    • builder

      public static IngestionStreamSummary.Builder builder()

    • serializableBuilderClass

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