Class IngestionStreamDetail

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

Details 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.

    • collectionId

      public final String collectionId()

      The unique identifier of the collection that the ingestion stream belongs to.

      Returns:
      The unique identifier of the collection that the ingestion stream belongs to.

    • 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.

    • failureIndexName

      public final String failureIndexName()

      The name of the index where documents that fail to be ingested are recorded.

      Returns:
      The name of the index where documents that fail to be ingested are recorded.

    • source

      public final IngestionStreamSource source()

      The Amazon S3 source that the ingestion stream ingests data from.

      Returns:
      The Amazon S3 source that the ingestion stream ingests data from.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.

    • status

      public final IngestionStreamStatus status()

      The current lifecycle status of the ingestion stream. For example, CREATING, ACTIVE, or DELETING.

      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. For example, CREATING, ACTIVE, or DELETING.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current lifecycle status of the ingestion stream. For example, CREATING, ACTIVE, or DELETING.

      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. For example, CREATING, ACTIVE, or DELETING.
      See Also:

    • state

      public final IngestionState state()

      The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.

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

      Returns:
      The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.

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

      Returns:
      The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.
      See Also:

    • statistics

      public final IngestionStatistics statistics()

      Processing statistics for the ingestion stream, such as the number of Amazon S3 objects discovered, ingested, and failed.

      Returns:
      Processing statistics for the ingestion stream, such as the number of Amazon S3 objects discovered, ingested, and failed.

    • revision

      public final Long revision()

      The revision number of the ingestion stream.

      Returns:
      The revision number of the ingestion stream.

    • 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.

    • hasFailureReasons

      public final boolean hasFailureReasons()
      For responses, this returns true if the service returned a value for the FailureReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • failureReasons

      public final List<IngestionFailureReason> failureReasons()

      The reasons that the ingestion stream reached a terminal failure state, if applicable.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailureReasons() method.

      Returns:
      The reasons that the ingestion stream reached a terminal failure state, if applicable.

    • hasActiveAlerts

      public final boolean hasActiveAlerts()
      For responses, this returns true if the service returned a value for the ActiveAlerts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • activeAlerts

      public final List<IngestionAlert> activeAlerts()

      Active alerts about operational issues that currently affect the ingestion stream. Alerts are cleared when the issue is resolved.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActiveAlerts() method.

      Returns:
      Active alerts about operational issues that currently affect the ingestion stream. Alerts are cleared when the issue is resolved.

    • toBuilder

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

    • builder

      public static IngestionStreamDetail.Builder builder()

    • serializableBuilderClass

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