com.amazonaws.services.mediaconvert.model.TeletextDestinationSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-mediaconvert Show documentation
Show all versions of aws-java-sdk-mediaconvert Show documentation
The AWS Java SDK for AWS Elemental MediaConvert module holds the client classes that are used for communicating with AWS Elemental MediaConvert Service
/*
* Copyright 2019-2024 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 com.amazonaws.services.mediaconvert.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* Settings related to teletext captions. Set up teletext captions in the same output as your video. For more
* information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html.
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TeletextDestinationSettings implements Serializable, Cloneable, StructuredPojo {
/**
* Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a
* three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of
* Teletext data, do not use this field.
*/
private String pageNumber;
/**
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type
* to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When
* you pass through a set of Teletext pages, your output has the same page types as your input.
*/
private java.util.List pageTypes;
/**
* Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a
* three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of
* Teletext data, do not use this field.
*
* @param pageNumber
* Set pageNumber to the Teletext page number for the destination captions for this output. This value must
* be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the
* entire set of Teletext data, do not use this field.
*/
public void setPageNumber(String pageNumber) {
this.pageNumber = pageNumber;
}
/**
* Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a
* three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of
* Teletext data, do not use this field.
*
* @return Set pageNumber to the Teletext page number for the destination captions for this output. This value must
* be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the
* entire set of Teletext data, do not use this field.
*/
public String getPageNumber() {
return this.pageNumber;
}
/**
* Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a
* three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of
* Teletext data, do not use this field.
*
* @param pageNumber
* Set pageNumber to the Teletext page number for the destination captions for this output. This value must
* be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the
* entire set of Teletext data, do not use this field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TeletextDestinationSettings withPageNumber(String pageNumber) {
setPageNumber(pageNumber);
return this;
}
/**
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type
* to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When
* you pass through a set of Teletext pages, your output has the same page types as your input.
*
* @return Specify the page types for this Teletext page. If you don't specify a value here, the service sets the
* page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use
* this field. When you pass through a set of Teletext pages, your output has the same page types as your
* input.
* @see TeletextPageType
*/
public java.util.List getPageTypes() {
return pageTypes;
}
/**
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type
* to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When
* you pass through a set of Teletext pages, your output has the same page types as your input.
*
* @param pageTypes
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the
* page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use
* this field. When you pass through a set of Teletext pages, your output has the same page types as your
* input.
* @see TeletextPageType
*/
public void setPageTypes(java.util.Collection pageTypes) {
if (pageTypes == null) {
this.pageTypes = null;
return;
}
this.pageTypes = new java.util.ArrayList(pageTypes);
}
/**
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type
* to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When
* you pass through a set of Teletext pages, your output has the same page types as your input.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPageTypes(java.util.Collection)} or {@link #withPageTypes(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param pageTypes
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the
* page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use
* this field. When you pass through a set of Teletext pages, your output has the same page types as your
* input.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TeletextPageType
*/
public TeletextDestinationSettings withPageTypes(String... pageTypes) {
if (this.pageTypes == null) {
setPageTypes(new java.util.ArrayList(pageTypes.length));
}
for (String ele : pageTypes) {
this.pageTypes.add(ele);
}
return this;
}
/**
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type
* to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When
* you pass through a set of Teletext pages, your output has the same page types as your input.
*
* @param pageTypes
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the
* page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use
* this field. When you pass through a set of Teletext pages, your output has the same page types as your
* input.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TeletextPageType
*/
public TeletextDestinationSettings withPageTypes(java.util.Collection pageTypes) {
setPageTypes(pageTypes);
return this;
}
/**
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type
* to the default value Subtitle. If you pass through the entire set of Teletext data, don't use this field. When
* you pass through a set of Teletext pages, your output has the same page types as your input.
*
* @param pageTypes
* Specify the page types for this Teletext page. If you don't specify a value here, the service sets the
* page type to the default value Subtitle. If you pass through the entire set of Teletext data, don't use
* this field. When you pass through a set of Teletext pages, your output has the same page types as your
* input.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TeletextPageType
*/
public TeletextDestinationSettings withPageTypes(TeletextPageType... pageTypes) {
java.util.ArrayList pageTypesCopy = new java.util.ArrayList(pageTypes.length);
for (TeletextPageType value : pageTypes) {
pageTypesCopy.add(value.toString());
}
if (getPageTypes() == null) {
setPageTypes(pageTypesCopy);
} else {
getPageTypes().addAll(pageTypesCopy);
}
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPageNumber() != null)
sb.append("PageNumber: ").append(getPageNumber()).append(",");
if (getPageTypes() != null)
sb.append("PageTypes: ").append(getPageTypes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TeletextDestinationSettings == false)
return false;
TeletextDestinationSettings other = (TeletextDestinationSettings) obj;
if (other.getPageNumber() == null ^ this.getPageNumber() == null)
return false;
if (other.getPageNumber() != null && other.getPageNumber().equals(this.getPageNumber()) == false)
return false;
if (other.getPageTypes() == null ^ this.getPageTypes() == null)
return false;
if (other.getPageTypes() != null && other.getPageTypes().equals(this.getPageTypes()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPageNumber() == null) ? 0 : getPageNumber().hashCode());
hashCode = prime * hashCode + ((getPageTypes() == null) ? 0 : getPageTypes().hashCode());
return hashCode;
}
@Override
public TeletextDestinationSettings clone() {
try {
return (TeletextDestinationSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.mediaconvert.model.transform.TeletextDestinationSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}