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>

  • Method Details

    • 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, sourceType will return MediaPipelineSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

      Returns:
      Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
      See Also:

    • 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, sourceType will return MediaPipelineSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

      Returns:
      Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
      See Also:

    • 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, 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()

      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. 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. Can only interact with S3Bucket sink 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 for SinkIamRoleArn.

      Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

      Returns:
      The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink 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 for SinkIamRoleArn.

      Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for 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 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.

    • 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()
      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<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>
      Specified by:
      toBuilder in class ChimeSdkMediaPipelinesRequest
      Returns:
      a builder for type T

    • builder

      public static CreateMediaCapturePipelineRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateMediaCapturePipelineRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.