Class Pipeline

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

The pipeline (queue) that is used to manage jobs.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

      Returns:
      The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the pipeline.

      Returns:
      The Amazon Resource Name (ARN) for the pipeline.

    • name

      public final String name()

      The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

      Constraints: Maximum 40 characters

      Returns:
      The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

      Constraints: Maximum 40 characters

    • status

      public final String status()

      The current status of the pipeline:

      • Active: The pipeline is processing jobs.

      • Paused: The pipeline is not currently processing jobs.

      Returns:
      The current status of the pipeline:

      • Active: The pipeline is processing jobs.

      • Paused: The pipeline is not currently processing jobs.

    • inputBucket

      public final String inputBucket()

      The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

      Returns:
      The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

    • outputBucket

      public final String outputBucket()

      The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

      Returns:
      The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

    • role

      public final String role()

      The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

      Returns:
      The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

    • awsKmsKeyArn

      public final String awsKmsKeyArn()

      The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

      If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

      Returns:
      The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

      If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

    • notifications

      public final Notifications notifications()

      The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

      To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

      • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

      • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

      • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

      • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

      Returns:
      The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

      To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

      • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

      • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

      • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

      • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

    • contentConfig

      public final PipelineOutputConfig contentConfig()

      Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

      • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

      • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

        • GranteeType: The type of value that appears in the Grantee object:

          • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

          • Email: The registered email address of an AWS account.

          • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

        • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

        • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

          • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

          • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

          • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

          • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

      Returns:
      Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

      • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

      • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

        • GranteeType: The type of value that appears in the Grantee object:

          • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

          • Email: The registered email address of an AWS account.

          • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

        • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

        • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

          • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

          • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

          • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

          • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

    • thumbnailConfig

      public final PipelineOutputConfig thumbnailConfig()

      Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

      • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

      • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

        • GranteeType: The type of value that appears in the Grantee object:

          • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

            A canonical user ID is not the same as an AWS account number.

          • Email: The registered email address of an AWS account.

          • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

        • Grantee: The AWS user or group that you want to have access to thumbnail files.

        • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

          • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

          • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

          • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

          • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

      Returns:
      Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

      • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

      • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

        • GranteeType: The type of value that appears in the Grantee object:

          • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

            A canonical user ID is not the same as an AWS account number.

          • Email: The registered email address of an AWS account.

          • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

        • Grantee: The AWS user or group that you want to have access to thumbnail files.

        • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

          • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

          • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

          • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

          • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

    • toBuilder

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

    • builder

      public static Pipeline.Builder builder()

    • serializableBuilderClass

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