com.amazonaws.services.mediapackagev2.model.CreateChannelRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-mediapackagev2 Show documentation
/*
* 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.mediapackagev2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateChannelRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name that describes the channel group. The name is the primary identifier for the channel group, and must be
* unique for your account in the AWS Region.
*
*/
private String channelGroupName;
/**
*
* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for
* your account in the AWS Region and channel group. You can't change the name after you create the channel.
*
*/
private String channelName;
/**
*
* A unique, case-sensitive token that you provide to ensure the idempotency of the request.
*
*/
private String clientToken;
/**
*
* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest
* or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
*
*/
private String inputType;
/**
*
* Enter any descriptive text that helps you to identify the channel.
*
*/
private String description;
/**
*
* A comma-separated list of tag key:value pairs that you define. For example:
*
*
* "Key1": "Value1",
*
*
* "Key2": "Value2"
*
*/
private java.util.Map tags;
/**
*
* The name that describes the channel group. The name is the primary identifier for the channel group, and must be
* unique for your account in the AWS Region.
*
*
* @param channelGroupName
* The name that describes the channel group. The name is the primary identifier for the channel group, and
* must be unique for your account in the AWS Region.
*/
public void setChannelGroupName(String channelGroupName) {
this.channelGroupName = channelGroupName;
}
/**
*
* The name that describes the channel group. The name is the primary identifier for the channel group, and must be
* unique for your account in the AWS Region.
*
*
* @return The name that describes the channel group. The name is the primary identifier for the channel group, and
* must be unique for your account in the AWS Region.
*/
public String getChannelGroupName() {
return this.channelGroupName;
}
/**
*
* The name that describes the channel group. The name is the primary identifier for the channel group, and must be
* unique for your account in the AWS Region.
*
*
* @param channelGroupName
* The name that describes the channel group. The name is the primary identifier for the channel group, and
* must be unique for your account in the AWS Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest withChannelGroupName(String channelGroupName) {
setChannelGroupName(channelGroupName);
return this;
}
/**
*
* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for
* your account in the AWS Region and channel group. You can't change the name after you create the channel.
*
*
* @param channelName
* The name that describes the channel. The name is the primary identifier for the channel, and must be
* unique for your account in the AWS Region and channel group. You can't change the name after you create
* the channel.
*/
public void setChannelName(String channelName) {
this.channelName = channelName;
}
/**
*
* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for
* your account in the AWS Region and channel group. You can't change the name after you create the channel.
*
*
* @return The name that describes the channel. The name is the primary identifier for the channel, and must be
* unique for your account in the AWS Region and channel group. You can't change the name after you create
* the channel.
*/
public String getChannelName() {
return this.channelName;
}
/**
*
* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for
* your account in the AWS Region and channel group. You can't change the name after you create the channel.
*
*
* @param channelName
* The name that describes the channel. The name is the primary identifier for the channel, and must be
* unique for your account in the AWS Region and channel group. You can't change the name after you create
* the channel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest withChannelName(String channelName) {
setChannelName(channelName);
return this;
}
/**
*
* A unique, case-sensitive token that you provide to ensure the idempotency of the request.
*
*
* @param clientToken
* A unique, case-sensitive token that you provide to ensure the idempotency of the request.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A unique, case-sensitive token that you provide to ensure the idempotency of the request.
*
*
* @return A unique, case-sensitive token that you provide to ensure the idempotency of the request.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A unique, case-sensitive token that you provide to ensure the idempotency of the request.
*
*
* @param clientToken
* A unique, case-sensitive token that you provide to ensure the idempotency of the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest
* or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
*
*
* @param inputType
* The input type will be an immutable field which will be used to define whether the channel will allow CMAF
* ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
* @see InputType
*/
public void setInputType(String inputType) {
this.inputType = inputType;
}
/**
*
* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest
* or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
*
*
* @return The input type will be an immutable field which will be used to define whether the channel will allow
* CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
* @see InputType
*/
public String getInputType() {
return this.inputType;
}
/**
*
* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest
* or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
*
*
* @param inputType
* The input type will be an immutable field which will be used to define whether the channel will allow CMAF
* ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InputType
*/
public CreateChannelRequest withInputType(String inputType) {
setInputType(inputType);
return this;
}
/**
*
* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest
* or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
*
*
* @param inputType
* The input type will be an immutable field which will be used to define whether the channel will allow CMAF
* ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
*
* The allowed values are:
*
*
* -
*
* HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
*
*
* -
*
* CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH
* manifests).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InputType
*/
public CreateChannelRequest withInputType(InputType inputType) {
this.inputType = inputType.toString();
return this;
}
/**
*
* Enter any descriptive text that helps you to identify the channel.
*
*
* @param description
* Enter any descriptive text that helps you to identify the channel.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Enter any descriptive text that helps you to identify the channel.
*
*
* @return Enter any descriptive text that helps you to identify the channel.
*/
public String getDescription() {
return this.description;
}
/**
*
* Enter any descriptive text that helps you to identify the channel.
*
*
* @param description
* Enter any descriptive text that helps you to identify the channel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* A comma-separated list of tag key:value pairs that you define. For example:
*
*
* "Key1": "Value1",
*
*
* "Key2": "Value2"
*
*
* @return A comma-separated list of tag key:value pairs that you define. For example:
*
* "Key1": "Value1",
*
*
* "Key2": "Value2"
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* A comma-separated list of tag key:value pairs that you define. For example:
*
*
* "Key1": "Value1",
*
*
* "Key2": "Value2"
*
*
* @param tags
* A comma-separated list of tag key:value pairs that you define. For example:
*
* "Key1": "Value1",
*
*
* "Key2": "Value2"
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* A comma-separated list of tag key:value pairs that you define. For example:
*
*
* "Key1": "Value1",
*
*
* "Key2": "Value2"
*
*
* @param tags
* A comma-separated list of tag key:value pairs that you define. For example:
*
* "Key1": "Value1",
*
*
* "Key2": "Value2"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateChannelRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest clearTagsEntries() {
this.tags = null;
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 (getChannelGroupName() != null)
sb.append("ChannelGroupName: ").append(getChannelGroupName()).append(",");
if (getChannelName() != null)
sb.append("ChannelName: ").append(getChannelName()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getInputType() != null)
sb.append("InputType: ").append(getInputType()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateChannelRequest == false)
return false;
CreateChannelRequest other = (CreateChannelRequest) obj;
if (other.getChannelGroupName() == null ^ this.getChannelGroupName() == null)
return false;
if (other.getChannelGroupName() != null && other.getChannelGroupName().equals(this.getChannelGroupName()) == false)
return false;
if (other.getChannelName() == null ^ this.getChannelName() == null)
return false;
if (other.getChannelName() != null && other.getChannelName().equals(this.getChannelName()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getInputType() == null ^ this.getInputType() == null)
return false;
if (other.getInputType() != null && other.getInputType().equals(this.getInputType()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getChannelGroupName() == null) ? 0 : getChannelGroupName().hashCode());
hashCode = prime * hashCode + ((getChannelName() == null) ? 0 : getChannelName().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getInputType() == null) ? 0 : getInputType().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateChannelRequest clone() {
return (CreateChannelRequest) super.clone();
}
}