Class PipelineSummary

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

Summary information for an OpenSearch Ingestion pipeline.

See Also:

  • Method Details

    • status

      public final PipelineStatus status()

      The current status of the pipeline.

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

      Returns:
      The current status of the pipeline.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the pipeline.

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

      Returns:
      The current status of the pipeline.
      See Also:

    • statusReason

      public final PipelineStatusReason statusReason()
      Returns the value of the StatusReason property for this object.
      Returns:
      The value of the StatusReason property for this object.

    • pipelineName

      public final String pipelineName()

      The name of the pipeline.

      Returns:
      The name of the pipeline.

    • pipelineArn

      public final String pipelineArn()

      The Amazon Resource Name (ARN) of the pipeline.

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

    • minUnits

      public final Integer minUnits()

      The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      Returns:
      The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

    • maxUnits

      public final Integer maxUnits()

      The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      Returns:
      The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

    • createdAt

      public final Instant createdAt()

      The date and time when the pipeline was created.

      Returns:
      The date and time when the pipeline was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The date and time when the pipeline was last updated.

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

    • hasDestinations

      public final boolean hasDestinations()
      For responses, this returns true if the service returned a value for the Destinations 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.

    • destinations

      public final List<PipelineDestination> destinations()

      A list of destinations to which the pipeline writes data.

      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 hasDestinations() method.

      Returns:
      A list of destinations to which the pipeline writes data.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      A list of tags associated with the given pipeline.

      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 hasTags() method.

      Returns:
      A list of tags associated with the given pipeline.

    • toBuilder

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

    • builder

      public static PipelineSummary.Builder builder()

    • serializableBuilderClass

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