Class CreateMediaCapturePipelineRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.chimesdkmediapipelines.model.ChimeSdkMediaPipelinesRequest
-
- software.amazon.awssdk.services.chimesdkmediapipelines.model.CreateMediaCapturePipelineRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMediaCapturePipelineRequest extends ChimeSdkMediaPipelinesRequest implements ToCopyableBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateMediaCapturePipelineRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateMediaCapturePipelineRequest.Builderbuilder()ChimeSdkMeetingConfigurationchimeSdkMeetingConfiguration()The configuration for a specified media pipeline.StringclientRequestToken()The unique identifier for the client request.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateMediaCapturePipelineRequest.Builder>serializableBuilderClass()StringsinkArn()The ARN of the sink type.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 captured.MediaPipelineSourceTypesourceType()Source type from which the media artifacts are captured.StringsourceTypeAsString()Source type from which the media artifacts are captured.SseAwsKeyManagementParamssseAwsKeyManagementParams()An object that contains server side encryption parameters to be used by media capture pipeline.List<Tag>tags()The tag key-value pairs.CreateMediaCapturePipelineRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
sourceType
public final MediaPipelineSourceType sourceType()
Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
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 the media artifacts are captured. A Chime SDK Meeting is the only supported source.
- See Also:
MediaPipelineSourceType
-
sourceTypeAsString
public final String sourceTypeAsString()
Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
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 the media artifacts are captured. A Chime SDK Meeting is the only supported source.
- See Also:
MediaPipelineSourceType
-
sourceArn
public final String sourceArn()
ARN of the source from which the media artifacts are captured.
- Returns:
- ARN of the source from which the media artifacts are captured.
-
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()
The ARN of the sink type.
- Returns:
- The ARN of the sink type.
-
clientRequestToken
public final String clientRequestToken()
The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
- Returns:
- The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
-
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. Can only interact withS3Bucketsink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same forSinkIamRoleArn.Additionally, the role must have permission to
kms:GenerateDataKeyusing KMS key supplied asAwsKmsKeyIdinSseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission tokms:Decryptfor the same KMS key.- Returns:
- The Amazon Resource Name (ARN) of the sink role to be used with
AwsKmsKeyIdinSseAwsKeyManagementParams. Can only interact withS3Bucketsink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same forSinkIamRoleArn.Additionally, the role must have permission to
kms:GenerateDataKeyusing KMS key supplied asAwsKmsKeyIdinSseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission tokms:Decryptfor the same KMS key.
-
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 theisEmpty()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()
The tag key-value pairs.
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:
- The tag key-value pairs.
-
toBuilder
public CreateMediaCapturePipelineRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>- Specified by:
toBuilderin classChimeSdkMediaPipelinesRequest
-
builder
public static CreateMediaCapturePipelineRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateMediaCapturePipelineRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-