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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceMediaCapturePipeline.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MediaCapturePipeline.Builderbuilder()ChimeSdkMeetingConfigurationchimeSdkMeetingConfiguration()The configuration for a specified media pipeline.InstantcreatedTimestamp()The time at which the pipeline was created, in ISO 8601 format.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringmediaPipelineArn()The ARN of the media capture pipelineStringmediaPipelineId()The ID of a media pipeline.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends MediaCapturePipeline.Builder>serializableBuilderClass()StringsinkArn()ARN of the destination to which the media artifacts are saved.StringsinkIamRoleArn()The Amazon Resource Name (ARN) of the sink role to be used withAwsKmsKeyIdinSseAwsKeyManagementParams.MediaPipelineSinkTypesinkType()Destination type to which the media artifacts are saved.StringsinkTypeAsString()Destination type to which the media artifacts are saved.StringsourceArn()ARN of the source from which the media artifacts are saved.MediaPipelineSourceTypesourceType()Source type from which media artifacts are saved.StringsourceTypeAsString()Source type from which media artifacts are saved.SseAwsKeyManagementParamssseAwsKeyManagementParams()An object that contains server side encryption parameters to be used by media capture pipeline.MediaPipelineStatusstatus()The status of the media pipeline.StringstatusAsString()The status of the media pipeline.MediaCapturePipeline.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedTimestamp()The time at which the pipeline was updated, in ISO 8601 format.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
sourceTypewill returnMediaPipelineSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsourceTypeAsString().- Returns:
- Source type from which media artifacts are saved. You must use
ChimeMeeting. - See Also:
MediaPipelineSourceType
-
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,
sourceTypewill returnMediaPipelineSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsourceTypeAsString().- Returns:
- Source type from which media artifacts are saved. You must use
ChimeMeeting. - See Also:
MediaPipelineSourceType
-
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,
statuswill returnMediaPipelineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the media pipeline.
- See Also:
MediaPipelineStatus
-
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,
statuswill returnMediaPipelineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the media pipeline.
- See Also:
MediaPipelineStatus
-
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,
sinkTypewill returnMediaPipelineSinkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsinkTypeAsString().- Returns:
- Destination type to which the media artifacts are saved. You must use an S3 Bucket.
- See Also:
MediaPipelineSinkType
-
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,
sinkTypewill returnMediaPipelineSinkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsinkTypeAsString().- Returns:
- Destination type to which the media artifacts are saved. You must use an S3 Bucket.
- See Also:
MediaPipelineSinkType
-
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.
SourceTypemust beChimeSdkMeeting.- Returns:
- The configuration for a specified media pipeline.
SourceTypemust beChimeSdkMeeting.
-
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
AwsKmsKeyIdinSseAwsKeyManagementParams.- Returns:
- The Amazon Resource Name (ARN) of the sink role to be used with
AwsKmsKeyIdinSseAwsKeyManagementParams.
-
toBuilder
public MediaCapturePipeline.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<MediaCapturePipeline.Builder,MediaCapturePipeline>
-
builder
public static MediaCapturePipeline.Builder builder()
-
serializableBuilderClass
public static Class<? extends MediaCapturePipeline.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-