software.amazon.awssdk.services.ivs.model

Class UpdateChannelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ivs.model.IvsRequest

software.amazon.awssdk.services.ivs.model.UpdateChannelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateChannelRequest.Builder,UpdateChannelRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateChannelRequest
extends IvsRequest
implements ToCopyableBuilder<UpdateChannelRequest.Builder,UpdateChannelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateChannelRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() ARN of the channel to be updated.
Boolean	authorized() Whether the channel is private (enabled for playback authorization).
static UpdateChannelRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	insecureIngest() Whether the channel allows insecure RTMP ingest.
ChannelLatencyMode	latencyMode() Channel latency mode.
String	latencyModeAsString() Channel latency mode.
String	name() Channel name.
TranscodePreset	preset() Optional transcode preset for the channel.
String	presetAsString() Optional transcode preset for the channel.
String	recordingConfigurationArn() Recording-configuration ARN.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateChannelRequest.Builder>	serializableBuilderClass()
UpdateChannelRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ChannelType	type() Channel type, which determines the allowable resolution and bitrate.
String	typeAsString() Channel type, which determines the allowable resolution and bitrate.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

ARN of the channel to be updated.

Returns:

ARN of the channel to be updated.

authorized

public final Boolean authorized()

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

Returns:

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

insecureIngest

public final Boolean insecureIngest()

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

Returns:

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

latencyMode

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

If the service returns an enum value that is not available in the current SDK version, latencyMode will return ChannelLatencyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from latencyModeAsString().

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

latencyModeAsString

public final String latencyModeAsString()

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

If the service returns an enum value that is not available in the current SDK version, latencyMode will return ChannelLatencyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from latencyModeAsString().

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

name

public final String name()

Channel name.

Returns:

Channel name.

preset

public final 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 ("").

If the service returns an enum value that is not available in the current SDK version, preset will return TranscodePreset.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from presetAsString().

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

presetAsString

public final String presetAsString()

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

If the service returns an enum value that is not available in the current SDK version, preset will return TranscodePreset.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from presetAsString().

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

recordingConfigurationArn

public final 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

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

type

public final 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.

If the service returns an enum value that is not available in the current SDK version, type will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

typeAsString

public final String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

toBuilder

public UpdateChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateChannelRequest.Builder,UpdateChannelRequest>

Specified by:

toBuilder in class IvsRequest

builder

public static UpdateChannelRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateChannelRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo