Class PipelineDetail

java.lang.Object
software.amazon.awssdk.services.medialive.model.PipelineDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PipelineDetail.Builder,PipelineDetail>
@Generated("software.amazon.awssdk:codegen") public final class PipelineDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PipelineDetail.Builder,PipelineDetail>
Runtime details of a pipeline when a channel is running.
See Also:

  • Method Details

    • activeInputAttachmentName

      public final String activeInputAttachmentName()
      The name of the active input attachment currently being ingested by this pipeline.
      Returns:
      The name of the active input attachment currently being ingested by this pipeline.

    • activeInputSwitchActionName

      public final String activeInputSwitchActionName()
      The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
      Returns:
      The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.

    • activeMotionGraphicsActionName

      public final String activeMotionGraphicsActionName()
      The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline.
      Returns:
      The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline.

    • activeMotionGraphicsUri

      public final String activeMotionGraphicsUri()
      The current URI being used for HTML5 motion graphics for this pipeline.
      Returns:
      The current URI being used for HTML5 motion graphics for this pipeline.

    • pipelineId

      public final String pipelineId()
      Pipeline ID
      Returns:
      Pipeline ID

    • channelEngineVersion

      public final ChannelEngineVersionResponse channelEngineVersion()
      Current engine version of the encoder for this pipeline.
      Returns:
      Current engine version of the encoder for this pipeline.

    • hasMediaConnectRouterOutputConnectionMap

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

    • mediaConnectRouterOutputConnectionMap

      public final Map<String,MediaConnectRouterOutputConnection> mediaConnectRouterOutputConnectionMap()
      A map of output names to the MediaConnect Router connection for this pipeline. Only present for channels with MediaConnect Router outputs.

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

      Returns:
      A map of output names to the MediaConnect Router connection for this pipeline. Only present for channels with MediaConnect Router outputs.

    • toBuilder

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

    • builder

      public static PipelineDetail.Builder builder()

    • serializableBuilderClass

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