com.amazonaws.services.ivs.model.CreateChannelRequest Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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.ivs.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 {
/**
*
* Whether the channel is private (enabled for playback authorization). Default: false.
*
*/
private Boolean authorized;
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW
* and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.
*
*/
private String latencyMode;
/**
*
* Channel name.
*
*/
private String name;
/**
*
* Recording-configuration ARN. Default: "" (empty string, recording is disabled).
*
*/
private String recordingConfigurationArn;
/**
*
* Array of 1-50 maps, each of the form string:string (key:value).
*
*/
private java.util.Map tags;
/**
*
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or
* bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
*
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give viewers
* the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up
* to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
* limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
*
*/
private String type;
/**
*
* Whether the channel is private (enabled for playback authorization). Default: false.
*
*
* @param authorized
* Whether the channel is private (enabled for playback authorization). Default: false.
*/
public void setAuthorized(Boolean authorized) {
this.authorized = authorized;
}
/**
*
* Whether the channel is private (enabled for playback authorization). Default: false.
*
*
* @return Whether the channel is private (enabled for playback authorization). Default: false.
*/
public Boolean getAuthorized() {
return this.authorized;
}
/**
*
* Whether the channel is private (enabled for playback authorization). Default: false.
*
*
* @param authorized
* Whether the channel is private (enabled for playback authorization). Default: false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest withAuthorized(Boolean authorized) {
setAuthorized(authorized);
return this;
}
/**
*
* Whether the channel is private (enabled for playback authorization). Default: false.
*
*
* @return Whether the channel is private (enabled for playback authorization). Default: false.
*/
public Boolean isAuthorized() {
return this.authorized;
}
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW
* and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.
*
*
* @param latencyMode
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console,
* LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default:
* LOW.
* @see ChannelLatencyMode
*/
public void setLatencyMode(String latencyMode) {
this.latencyMode = latencyMode;
}
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW
* and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.
*
*
* @return Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console,
* LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default:
* LOW.
* @see ChannelLatencyMode
*/
public String getLatencyMode() {
return this.latencyMode;
}
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW
* and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.
*
*
* @param latencyMode
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console,
* LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default:
* LOW.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelLatencyMode
*/
public CreateChannelRequest withLatencyMode(String latencyMode) {
setLatencyMode(latencyMode);
return this;
}
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW
* and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.
*
*
* @param latencyMode
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console,
* LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default:
* LOW.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelLatencyMode
*/
public CreateChannelRequest withLatencyMode(ChannelLatencyMode latencyMode) {
this.latencyMode = latencyMode.toString();
return this;
}
/**
*
* Channel name.
*
*
* @param name
* Channel name.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* Channel name.
*
*
* @return Channel name.
*/
public String getName() {
return this.name;
}
/**
*
* Channel name.
*
*
* @param name
* Channel name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest withName(String name) {
setName(name);
return this;
}
/**
*
* Recording-configuration ARN. Default: "" (empty string, recording is disabled).
*
*
* @param recordingConfigurationArn
* Recording-configuration ARN. Default: "" (empty string, recording is disabled).
*/
public void setRecordingConfigurationArn(String recordingConfigurationArn) {
this.recordingConfigurationArn = recordingConfigurationArn;
}
/**
*
* Recording-configuration ARN. Default: "" (empty string, recording is disabled).
*
*
* @return Recording-configuration ARN. Default: "" (empty string, recording is disabled).
*/
public String getRecordingConfigurationArn() {
return this.recordingConfigurationArn;
}
/**
*
* Recording-configuration ARN. Default: "" (empty string, recording is disabled).
*
*
* @param recordingConfigurationArn
* Recording-configuration ARN. Default: "" (empty string, recording is disabled).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateChannelRequest withRecordingConfigurationArn(String recordingConfigurationArn) {
setRecordingConfigurationArn(recordingConfigurationArn);
return this;
}
/**
*
* Array of 1-50 maps, each of the form string:string (key:value).
*
*
* @return Array of 1-50 maps, each of the form string:string (key:value).
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* Array of 1-50 maps, each of the form string:string (key:value).
*
*
* @param tags
* Array of 1-50 maps, each of the form string:string (key:value).
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* Array of 1-50 maps, each of the form string:string (key:value).
*
*
* @param tags
* Array of 1-50 maps, each of the form string:string (key:value).
* @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;
}
/**
*
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or
* bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
*
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give viewers
* the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up
* to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
* limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
*
*
* @param type
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable
* resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
* . Valid values:
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give
* viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and
* bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio
* is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice
* is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
* @see ChannelType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or
* bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
*
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give viewers
* the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up
* to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
* limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
*
*
* @return Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable
* resolution or bitrate, the stream probably will disconnect immediately. Default:
* STANDARD. Valid values:
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give
* viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and
* bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio
* is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice
* is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
* @see ChannelType
*/
public String getType() {
return this.type;
}
/**
*
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or
* bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
*
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give viewers
* the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up
* to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
* limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
*
*
* @param type
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable
* resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
* . Valid values:
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give
* viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and
* bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio
* is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice
* is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelType
*/
public CreateChannelRequest withType(String type) {
setType(type);
return this;
}
/**
*
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or
* bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
*
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give viewers
* the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up
* to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
* limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
*
*
* @param type
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable
* resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
* . Valid values:
*
* -
*
* STANDARD: Multiple qualities are generated from the original input, to automatically give
* viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and
* bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio
* is passed through.
*
*
* -
*
* BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice
* is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelType
*/
public CreateChannelRequest withType(ChannelType type) {
this.type = type.toString();
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 (getAuthorized() != null)
sb.append("Authorized: ").append(getAuthorized()).append(",");
if (getLatencyMode() != null)
sb.append("LatencyMode: ").append(getLatencyMode()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getRecordingConfigurationArn() != null)
sb.append("RecordingConfigurationArn: ").append(getRecordingConfigurationArn()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
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.getAuthorized() == null ^ this.getAuthorized() == null)
return false;
if (other.getAuthorized() != null && other.getAuthorized().equals(this.getAuthorized()) == false)
return false;
if (other.getLatencyMode() == null ^ this.getLatencyMode() == null)
return false;
if (other.getLatencyMode() != null && other.getLatencyMode().equals(this.getLatencyMode()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getRecordingConfigurationArn() == null ^ this.getRecordingConfigurationArn() == null)
return false;
if (other.getRecordingConfigurationArn() != null && other.getRecordingConfigurationArn().equals(this.getRecordingConfigurationArn()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAuthorized() == null) ? 0 : getAuthorized().hashCode());
hashCode = prime * hashCode + ((getLatencyMode() == null) ? 0 : getLatencyMode().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getRecordingConfigurationArn() == null) ? 0 : getRecordingConfigurationArn().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public CreateChannelRequest clone() {
return (CreateChannelRequest) super.clone();
}
}