com.amazonaws.services.ivs.model

Class UpdateChannelRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ivs.model.UpdateChannelRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateChannelRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateChannelRequest()

Method Summary

Modifier and Type	Method and Description
UpdateChannelRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getArn() ARN of the channel to be updated.
Boolean	getAuthorized() Whether the channel is private (enabled for playback authorization).
Boolean	getInsecureIngest() Whether the channel allows insecure RTMP ingest.
String	getLatencyMode() Channel latency mode.
String	getName() Channel name.
String	getPreset() Optional transcode preset for the channel.
String	getRecordingConfigurationArn() Recording-configuration ARN.
String	getType() Channel type, which determines the allowable resolution and bitrate.
int	hashCode()
Boolean	isAuthorized() Whether the channel is private (enabled for playback authorization).
Boolean	isInsecureIngest() Whether the channel allows insecure RTMP ingest.
void	setArn(String arn) ARN of the channel to be updated.
void	setAuthorized(Boolean authorized) Whether the channel is private (enabled for playback authorization).
void	setInsecureIngest(Boolean insecureIngest) Whether the channel allows insecure RTMP ingest.
void	setLatencyMode(String latencyMode) Channel latency mode.
void	setName(String name) Channel name.
void	setPreset(String preset) Optional transcode preset for the channel.
void	setRecordingConfigurationArn(String recordingConfigurationArn) Recording-configuration ARN.
void	setType(String type) Channel type, which determines the allowable resolution and bitrate.
String	toString() Returns a string representation of this object.
UpdateChannelRequest	withArn(String arn) ARN of the channel to be updated.
UpdateChannelRequest	withAuthorized(Boolean authorized) Whether the channel is private (enabled for playback authorization).
UpdateChannelRequest	withInsecureIngest(Boolean insecureIngest) Whether the channel allows insecure RTMP ingest.
UpdateChannelRequest	withLatencyMode(ChannelLatencyMode latencyMode) Channel latency mode.
UpdateChannelRequest	withLatencyMode(String latencyMode) Channel latency mode.
UpdateChannelRequest	withName(String name) Channel name.
UpdateChannelRequest	withPreset(String preset) Optional transcode preset for the channel.
UpdateChannelRequest	withPreset(TranscodePreset preset) Optional transcode preset for the channel.
UpdateChannelRequest	withRecordingConfigurationArn(String recordingConfigurationArn) Recording-configuration ARN.
UpdateChannelRequest	withType(ChannelType type) Channel type, which determines the allowable resolution and bitrate.
UpdateChannelRequest	withType(String type) Channel type, which determines the allowable resolution and bitrate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateChannelRequest

public UpdateChannelRequest()

Method Detail

setArn

public void setArn(String arn)

ARN of the channel to be updated.

Parameters:

arn - ARN of the channel to be updated.

getArn

public String getArn()

ARN of the channel to be updated.

Returns:

ARN of the channel to be updated.

withArn

public UpdateChannelRequest withArn(String arn)

ARN of the channel to be updated.

Parameters:

arn - ARN of the channel to be updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthorized

public void setAuthorized(Boolean authorized)

Whether the channel is private (enabled for playback authorization).

Parameters:

authorized - Whether the channel is private (enabled for playback authorization).

getAuthorized

public Boolean getAuthorized()

Whether the channel is private (enabled for playback authorization).

Returns:

Whether the channel is private (enabled for playback authorization).

withAuthorized

public UpdateChannelRequest withAuthorized(Boolean authorized)

Whether the channel is private (enabled for playback authorization).

Parameters:

authorized - Whether the channel is private (enabled for playback authorization).

Returns:

Returns a reference to this object so that method calls can be chained together.

isAuthorized

public Boolean isAuthorized()

Whether the channel is private (enabled for playback authorization).

Returns:

Whether the channel is private (enabled for playback authorization).

setInsecureIngest

public void setInsecureIngest(Boolean insecureIngest)

Whether the channel allows insecure RTMP ingest. Default: false.

Parameters:

insecureIngest - Whether the channel allows insecure RTMP ingest. Default: false.

getInsecureIngest

public Boolean getInsecureIngest()

Whether the channel allows insecure RTMP ingest. Default: false.

Returns:

Whether the channel allows insecure RTMP ingest. Default: false.

withInsecureIngest

public UpdateChannelRequest withInsecureIngest(Boolean insecureIngest)

Whether the channel allows insecure RTMP ingest. Default: false.

Parameters:

insecureIngest - Whether the channel allows insecure RTMP ingest. Default: false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isInsecureIngest

public Boolean isInsecureIngest()

Whether the channel allows insecure RTMP ingest. Default: false.

Returns:

Whether the channel allows insecure RTMP ingest. Default: false.

setLatencyMode

public void setLatencyMode(String 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.)

Parameters:

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.)

See Also:

ChannelLatencyMode

getLatencyMode

public String getLatencyMode()

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.)

Returns:

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.)

See Also:

ChannelLatencyMode

withLatencyMode

public UpdateChannelRequest withLatencyMode(String 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.)

Parameters:

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.)

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelLatencyMode

withLatencyMode

public UpdateChannelRequest withLatencyMode(ChannelLatencyMode 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.)

Parameters:

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.)

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelLatencyMode

setName

public void setName(String name)

Channel name.

Parameters:

name - Channel name.

getName

public String getName()

Channel name.

Returns:

Channel name.

withName

public UpdateChannelRequest withName(String name)

Channel name.

Parameters:

name - Channel name.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreset

public void setPreset(String preset)

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

Parameters:

preset - Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

See Also:

TranscodePreset

getPreset

public String getPreset()

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

Returns:

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

See Also:

TranscodePreset

withPreset

public UpdateChannelRequest withPreset(String preset)

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

Parameters:

preset - Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TranscodePreset

withPreset

public UpdateChannelRequest withPreset(TranscodePreset preset)

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

Parameters:

preset - Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TranscodePreset

setRecordingConfigurationArn

public void setRecordingConfigurationArn(String recordingConfigurationArn)

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Parameters:

recordingConfigurationArn - Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

getRecordingConfigurationArn

public String getRecordingConfigurationArn()

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Returns:

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

withRecordingConfigurationArn

public UpdateChannelRequest withRecordingConfigurationArn(String recordingConfigurationArn)

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Parameters:

recordingConfigurationArn - Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

Parameters:

type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . For details, see Channel Types.

See Also:

ChannelType

getType

public String getType()

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

Returns:

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

See Also:

ChannelType

withType

public UpdateChannelRequest withType(String type)

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

Parameters:

type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . For details, see Channel Types.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelType

withType

public UpdateChannelRequest withType(ChannelType type)

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

Parameters:

type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . For details, see Channel Types.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelType

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateChannelRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()