Class MediaCapturePipeline

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

A media pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

See Also:

  • Method Details

    • mediaPipelineId

      public final String mediaPipelineId()

      The ID of a media pipeline.

      Returns:
      The ID of a media pipeline.

    • mediaPipelineArn

      public final String mediaPipelineArn()

      The ARN of the media capture pipeline

      Returns:
      The ARN of the media capture pipeline

    • sourceType

      public final MediaPipelineSourceType sourceType()

      Source type from which media artifacts are saved. You must use ChimeMeeting.

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

      Returns:
      Source type from which media artifacts are saved. You must use ChimeMeeting.
      See Also:

    • sourceTypeAsString

      public final String sourceTypeAsString()

      Source type from which media artifacts are saved. You must use ChimeMeeting.

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

      Returns:
      Source type from which media artifacts are saved. You must use ChimeMeeting.
      See Also:

    • sourceArn

      public final String sourceArn()

      ARN of the source from which the media artifacts are saved.

      Returns:
      ARN of the source from which the media artifacts are saved.

    • status

      public final MediaPipelineStatus status()

      The status of the media 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 the media pipeline.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the media 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 the media pipeline.
      See Also:

    • sinkType

      public final MediaPipelineSinkType sinkType()

      Destination type to which the media artifacts are saved. You must use an S3 Bucket.

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

      Returns:
      Destination type to which the media artifacts are saved. You must use an S3 Bucket.
      See Also:

    • sinkTypeAsString

      public final String sinkTypeAsString()

      Destination type to which the media artifacts are saved. You must use an S3 Bucket.

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

      Returns:
      Destination type to which the media artifacts are saved. You must use an S3 Bucket.
      See Also:

    • sinkArn

      public final String sinkArn()

      ARN of the destination to which the media artifacts are saved.

      Returns:
      ARN of the destination to which the media artifacts are saved.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time at which the pipeline was created, in ISO 8601 format.

      Returns:
      The time at which the pipeline was created, in ISO 8601 format.

    • updatedTimestamp

      public final Instant updatedTimestamp()

      The time at which the pipeline was updated, in ISO 8601 format.

      Returns:
      The time at which the pipeline was updated, in ISO 8601 format.

    • chimeSdkMeetingConfiguration

      public final ChimeSdkMeetingConfiguration chimeSdkMeetingConfiguration()

      The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

      Returns:
      The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

    • sseAwsKeyManagementParams

      public final SseAwsKeyManagementParams sseAwsKeyManagementParams()

      An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

      Returns:
      An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

    • sinkIamRoleArn

      public final String sinkIamRoleArn()

      The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams.

      Returns:
      The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams.

    • toBuilder

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

    • builder

      public static MediaCapturePipeline.Builder builder()

    • serializableBuilderClass

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