software.amazon.awssdk.services.elastictranscoder.model.Pipeline Maven / Gradle / Ivy
Show all versions of elastictranscoder Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.elastictranscoder.model;
import java.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The pipeline (queue) that is used to manage jobs.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Pipeline implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(Pipeline::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(Pipeline::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Pipeline::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(Pipeline::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField INPUT_BUCKET_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InputBucket").getter(getter(Pipeline::inputBucket)).setter(setter(Builder::inputBucket))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InputBucket").build()).build();
private static final SdkField OUTPUT_BUCKET_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutputBucket").getter(getter(Pipeline::outputBucket)).setter(setter(Builder::outputBucket))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputBucket").build()).build();
private static final SdkField ROLE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Role")
.getter(getter(Pipeline::role)).setter(setter(Builder::role))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Role").build()).build();
private static final SdkField AWS_KMS_KEY_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AwsKmsKeyArn").getter(getter(Pipeline::awsKmsKeyArn)).setter(setter(Builder::awsKmsKeyArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AwsKmsKeyArn").build()).build();
private static final SdkField NOTIFICATIONS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Notifications").getter(getter(Pipeline::notifications)).setter(setter(Builder::notifications))
.constructor(Notifications::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Notifications").build()).build();
private static final SdkField CONTENT_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ContentConfig")
.getter(getter(Pipeline::contentConfig)).setter(setter(Builder::contentConfig))
.constructor(PipelineOutputConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContentConfig").build()).build();
private static final SdkField THUMBNAIL_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ThumbnailConfig")
.getter(getter(Pipeline::thumbnailConfig)).setter(setter(Builder::thumbnailConfig))
.constructor(PipelineOutputConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ThumbnailConfig").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD,
NAME_FIELD, STATUS_FIELD, INPUT_BUCKET_FIELD, OUTPUT_BUCKET_FIELD, ROLE_FIELD, AWS_KMS_KEY_ARN_FIELD,
NOTIFICATIONS_FIELD, CONTENT_CONFIG_FIELD, THUMBNAIL_CONFIG_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String arn;
private final String name;
private final String status;
private final String inputBucket;
private final String outputBucket;
private final String role;
private final String awsKmsKeyArn;
private final Notifications notifications;
private final PipelineOutputConfig contentConfig;
private final PipelineOutputConfig thumbnailConfig;
private Pipeline(BuilderImpl builder) {
this.id = builder.id;
this.arn = builder.arn;
this.name = builder.name;
this.status = builder.status;
this.inputBucket = builder.inputBucket;
this.outputBucket = builder.outputBucket;
this.role = builder.role;
this.awsKmsKeyArn = builder.awsKmsKeyArn;
this.notifications = builder.notifications;
this.contentConfig = builder.contentConfig;
this.thumbnailConfig = builder.thumbnailConfig;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String id() {
return id;
}
/**
*
* The Amazon Resource Name (ARN) for the pipeline.
*
*
* @return The Amazon Resource Name (ARN) for the pipeline.
*/
public final String arn() {
return arn;
}
/**
*
* 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
*
*
* @return 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
*/
public final String name() {
return name;
}
/**
*
* The current status of the pipeline:
*
*
* -
*
* Active: The pipeline is processing jobs.
*
*
* -
*
* Paused: The pipeline is not currently processing jobs.
*
*
*
*
* @return The current status of the pipeline:
*
* -
*
* Active: The pipeline is processing jobs.
*
*
* -
*
* Paused: The pipeline is not currently processing jobs.
*
*
*/
public final String status() {
return status;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String inputBucket() {
return inputBucket;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String outputBucket() {
return outputBucket;
}
/**
*
* The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.
*
*
* @return The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this
* pipeline.
*/
public final String role() {
return role;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String awsKmsKeyArn() {
return awsKmsKeyArn;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public final Notifications notifications() {
return notifications;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public final PipelineOutputConfig contentConfig() {
return contentConfig;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public final PipelineOutputConfig thumbnailConfig() {
return thumbnailConfig;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(inputBucket());
hashCode = 31 * hashCode + Objects.hashCode(outputBucket());
hashCode = 31 * hashCode + Objects.hashCode(role());
hashCode = 31 * hashCode + Objects.hashCode(awsKmsKeyArn());
hashCode = 31 * hashCode + Objects.hashCode(notifications());
hashCode = 31 * hashCode + Objects.hashCode(contentConfig());
hashCode = 31 * hashCode + Objects.hashCode(thumbnailConfig());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Pipeline)) {
return false;
}
Pipeline other = (Pipeline) obj;
return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name())
&& Objects.equals(status(), other.status()) && Objects.equals(inputBucket(), other.inputBucket())
&& Objects.equals(outputBucket(), other.outputBucket()) && Objects.equals(role(), other.role())
&& Objects.equals(awsKmsKeyArn(), other.awsKmsKeyArn()) && Objects.equals(notifications(), other.notifications())
&& Objects.equals(contentConfig(), other.contentConfig())
&& Objects.equals(thumbnailConfig(), other.thumbnailConfig());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Pipeline").add("Id", id()).add("Arn", arn()).add("Name", name()).add("Status", status())
.add("InputBucket", inputBucket()).add("OutputBucket", outputBucket()).add("Role", role())
.add("AwsKmsKeyArn", awsKmsKeyArn()).add("Notifications", notifications()).add("ContentConfig", contentConfig())
.add("ThumbnailConfig", thumbnailConfig()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Status":
return Optional.ofNullable(clazz.cast(status()));
case "InputBucket":
return Optional.ofNullable(clazz.cast(inputBucket()));
case "OutputBucket":
return Optional.ofNullable(clazz.cast(outputBucket()));
case "Role":
return Optional.ofNullable(clazz.cast(role()));
case "AwsKmsKeyArn":
return Optional.ofNullable(clazz.cast(awsKmsKeyArn()));
case "Notifications":
return Optional.ofNullable(clazz.cast(notifications()));
case "ContentConfig":
return Optional.ofNullable(clazz.cast(contentConfig()));
case "ThumbnailConfig":
return Optional.ofNullable(clazz.cast(thumbnailConfig()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Pipeline) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The Amazon Resource Name (ARN) for the pipeline.
*
*
* @param arn
* The Amazon Resource Name (ARN) for the pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* 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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The current status of the pipeline:
*
*
* -
*
* Active: The pipeline is processing jobs.
*
*
* -
*
* Paused: The pipeline is not currently processing jobs.
*
*
*
*
* @param status
* The current status of the pipeline:
*
* -
*
* Active: The pipeline is processing jobs.
*
*
* -
*
* Paused: The pipeline is not currently processing jobs.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(String status);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inputBucket(String inputBucket);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputBucket(String outputBucket);
/**
*
* The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this
* pipeline.
*
*
* @param role
* The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for
* this pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder role(String role);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder awsKmsKeyArn(String awsKmsKeyArn);
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder notifications(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.
*
*
*
* This is a convenience that creates an instance of the {@link Notifications.Builder} avoiding the need to
* create one manually via {@link Notifications#builder()}.
*
* When the {@link Consumer} completes, {@link Notifications.Builder#build()} is called immediately and its
* result is passed to {@link #notifications(Notifications)}.
*
* @param notifications
* a consumer that will call methods on {@link Notifications.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #notifications(Notifications)
*/
default Builder notifications(Consumer notifications) {
return notifications(Notifications.builder().applyMutation(notifications).build());
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentConfig(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.
*
*
*
* This is a convenience that creates an instance of the {@link PipelineOutputConfig.Builder} avoiding the need
* to create one manually via {@link PipelineOutputConfig#builder()}.
*
* When the {@link Consumer} completes, {@link PipelineOutputConfig.Builder#build()} is called immediately and
* its result is passed to {@link #contentConfig(PipelineOutputConfig)}.
*
* @param contentConfig
* a consumer that will call methods on {@link PipelineOutputConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #contentConfig(PipelineOutputConfig)
*/
default Builder contentConfig(Consumer contentConfig) {
return contentConfig(PipelineOutputConfig.builder().applyMutation(contentConfig).build());
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder thumbnailConfig(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.
*
*
*
* This is a convenience that creates an instance of the {@link PipelineOutputConfig.Builder} avoiding the need
* to create one manually via {@link PipelineOutputConfig#builder()}.
*
* When the {@link Consumer} completes, {@link PipelineOutputConfig.Builder#build()} is called immediately and
* its result is passed to {@link #thumbnailConfig(PipelineOutputConfig)}.
*
* @param thumbnailConfig
* a consumer that will call methods on {@link PipelineOutputConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #thumbnailConfig(PipelineOutputConfig)
*/
default Builder thumbnailConfig(Consumer thumbnailConfig) {
return thumbnailConfig(PipelineOutputConfig.builder().applyMutation(thumbnailConfig).build());
}
}
static final class BuilderImpl implements Builder {
private String id;
private String arn;
private String name;
private String status;
private String inputBucket;
private String outputBucket;
private String role;
private String awsKmsKeyArn;
private Notifications notifications;
private PipelineOutputConfig contentConfig;
private PipelineOutputConfig thumbnailConfig;
private BuilderImpl() {
}
private BuilderImpl(Pipeline model) {
id(model.id);
arn(model.arn);
name(model.name);
status(model.status);
inputBucket(model.inputBucket);
outputBucket(model.outputBucket);
role(model.role);
awsKmsKeyArn(model.awsKmsKeyArn);
notifications(model.notifications);
contentConfig(model.contentConfig);
thumbnailConfig(model.thumbnailConfig);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
@Transient
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
@Transient
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
@Transient
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
@Transient
public final Builder status(String status) {
this.status = status;
return this;
}
public final String getInputBucket() {
return inputBucket;
}
public final void setInputBucket(String inputBucket) {
this.inputBucket = inputBucket;
}
@Override
@Transient
public final Builder inputBucket(String inputBucket) {
this.inputBucket = inputBucket;
return this;
}
public final String getOutputBucket() {
return outputBucket;
}
public final void setOutputBucket(String outputBucket) {
this.outputBucket = outputBucket;
}
@Override
@Transient
public final Builder outputBucket(String outputBucket) {
this.outputBucket = outputBucket;
return this;
}
public final String getRole() {
return role;
}
public final void setRole(String role) {
this.role = role;
}
@Override
@Transient
public final Builder role(String role) {
this.role = role;
return this;
}
public final String getAwsKmsKeyArn() {
return awsKmsKeyArn;
}
public final void setAwsKmsKeyArn(String awsKmsKeyArn) {
this.awsKmsKeyArn = awsKmsKeyArn;
}
@Override
@Transient
public final Builder awsKmsKeyArn(String awsKmsKeyArn) {
this.awsKmsKeyArn = awsKmsKeyArn;
return this;
}
public final Notifications.Builder getNotifications() {
return notifications != null ? notifications.toBuilder() : null;
}
public final void setNotifications(Notifications.BuilderImpl notifications) {
this.notifications = notifications != null ? notifications.build() : null;
}
@Override
@Transient
public final Builder notifications(Notifications notifications) {
this.notifications = notifications;
return this;
}
public final PipelineOutputConfig.Builder getContentConfig() {
return contentConfig != null ? contentConfig.toBuilder() : null;
}
public final void setContentConfig(PipelineOutputConfig.BuilderImpl contentConfig) {
this.contentConfig = contentConfig != null ? contentConfig.build() : null;
}
@Override
@Transient
public final Builder contentConfig(PipelineOutputConfig contentConfig) {
this.contentConfig = contentConfig;
return this;
}
public final PipelineOutputConfig.Builder getThumbnailConfig() {
return thumbnailConfig != null ? thumbnailConfig.toBuilder() : null;
}
public final void setThumbnailConfig(PipelineOutputConfig.BuilderImpl thumbnailConfig) {
this.thumbnailConfig = thumbnailConfig != null ? thumbnailConfig.build() : null;
}
@Override
@Transient
public final Builder thumbnailConfig(PipelineOutputConfig thumbnailConfig) {
this.thumbnailConfig = thumbnailConfig;
return this;
}
@Override
public Pipeline build() {
return new Pipeline(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}