Class MediaInsightsPipeline

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

A media pipeline that streams call analytics data.

See Also:

  • Method Details

    • mediaPipelineId

      public final String mediaPipelineId()

      The ID of a media insights pipeline.

      Returns:
      The ID of a media insights pipeline.

    • mediaPipelineArn

      public final String mediaPipelineArn()

      The ARN of a media insights pipeline.

      Returns:
      The ARN of a media insights pipeline.

    • mediaInsightsPipelineConfigurationArn

      public final String mediaInsightsPipelineConfigurationArn()

      The ARN of a media insight pipeline's configuration settings.

      Returns:
      The ARN of a media insight pipeline's configuration settings.

    • status

      public final MediaPipelineStatus status()

      The status of a media insights pipeline.

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

      Returns:
      The status of a media insights pipeline.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a media insights pipeline.

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

      Returns:
      The status of a media insights pipeline.
      See Also:

    • kinesisVideoStreamSourceRuntimeConfiguration

      public final KinesisVideoStreamSourceRuntimeConfiguration kinesisVideoStreamSourceRuntimeConfiguration()

      The configuration settings for a Kinesis runtime video stream in a media insights pipeline.

      Returns:
      The configuration settings for a Kinesis runtime video stream in a media insights pipeline.

    • hasMediaInsightsRuntimeMetadata

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

    • mediaInsightsRuntimeMetadata

      public final Map<String,String> mediaInsightsRuntimeMetadata()

      The runtime metadata of a media insights 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 hasMediaInsightsRuntimeMetadata() method.

      Returns:
      The runtime metadata of a media insights pipeline.

    • kinesisVideoStreamRecordingSourceRuntimeConfiguration

      public final KinesisVideoStreamRecordingSourceRuntimeConfiguration kinesisVideoStreamRecordingSourceRuntimeConfiguration()

      The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.

      Returns:
      The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.

    • s3RecordingSinkRuntimeConfiguration

      public final S3RecordingSinkRuntimeConfiguration s3RecordingSinkRuntimeConfiguration()

      The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.

      Returns:
      The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time at which the media insights pipeline was created.

      Returns:
      The time at which the media insights pipeline was created.

    • hasElementStatuses

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

    • elementStatuses

      public final List<MediaInsightsPipelineElementStatus> elementStatuses()

      The statuses that the elements in a media insights pipeline can have during data processing.

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

      Returns:
      The statuses that the elements in a media insights pipeline can have during data processing.

    • toBuilder

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

    • builder

      public static MediaInsightsPipeline.Builder builder()

    • serializableBuilderClass

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