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("software.amazon.awssdk:codegen") public final class UpdateChannelRequest extends IvsRequest implements ToCopyableBuilder<UpdateChannelRequest.Builder,UpdateChannelRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateChannelRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()ARN of the channel to be updated.Booleanauthorized()Whether the channel is private (enabled for playback authorization).static UpdateChannelRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()BooleaninsecureIngest()Whether the channel allows insecure RTMP ingest.ChannelLatencyModelatencyMode()Channel latency mode.StringlatencyModeAsString()Channel latency mode.Stringname()Channel name.StringplaybackRestrictionPolicyArn()Playback-restriction-policy ARN.TranscodePresetpreset()Optional transcode preset for the channel.StringpresetAsString()Optional transcode preset for the channel.StringrecordingConfigurationArn()Recording-configuration ARN.List<SdkField<?>>sdkFields()static Class<? extends UpdateChannelRequest.Builder>serializableBuilderClass()UpdateChannelRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.ChannelTypetype()Channel type, which determines the allowable resolution and bitrate.StringtypeAsString()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
NORMALto broadcast and deliver live video up to Full HD. UseLOWfor near-real-time interaction with viewers.If the service returns an enum value that is not available in the current SDK version,
latencyModewill returnChannelLatencyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlatencyModeAsString().- Returns:
- Channel latency mode. Use
NORMALto broadcast and deliver live video up to Full HD. UseLOWfor near-real-time interaction with viewers. - See Also:
ChannelLatencyMode
-
latencyModeAsString
public final String latencyModeAsString()
Channel latency mode. Use
NORMALto broadcast and deliver live video up to Full HD. UseLOWfor near-real-time interaction with viewers.If the service returns an enum value that is not available in the current SDK version,
latencyModewill returnChannelLatencyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlatencyModeAsString().- Returns:
- Channel latency mode. Use
NORMALto broadcast and deliver live video up to Full HD. UseLOWfor near-real-time interaction with viewers. - See Also:
ChannelLatencyMode
-
name
public final String name()
Channel name.
- Returns:
- Channel name.
-
playbackRestrictionPolicyArn
public final String playbackRestrictionPolicyArn()
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
- Returns:
- Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
-
preset
public final TranscodePreset preset()
Optional transcode preset for the channel. This is selectable only for
ADVANCED_HDandADVANCED_SDchannel types. For those channel types, the defaultpresetisHIGHER_BANDWIDTH_DELIVERY. For other channel types (BASICandSTANDARD),presetis the empty string ("").If the service returns an enum value that is not available in the current SDK version,
presetwill returnTranscodePreset.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompresetAsString().- Returns:
- Optional transcode preset for the channel. This is selectable only for
ADVANCED_HDandADVANCED_SDchannel types. For those channel types, the defaultpresetisHIGHER_BANDWIDTH_DELIVERY. For other channel types (BASICandSTANDARD),presetis the empty string (""). - See Also:
TranscodePreset
-
presetAsString
public final String presetAsString()
Optional transcode preset for the channel. This is selectable only for
ADVANCED_HDandADVANCED_SDchannel types. For those channel types, the defaultpresetisHIGHER_BANDWIDTH_DELIVERY. For other channel types (BASICandSTANDARD),presetis the empty string ("").If the service returns an enum value that is not available in the current SDK version,
presetwill returnTranscodePreset.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompresetAsString().- Returns:
- Optional transcode preset for the channel. This is selectable only for
ADVANCED_HDandADVANCED_SDchannel types. For those channel types, the defaultpresetisHIGHER_BANDWIDTH_DELIVERY. For other channel types (BASICandSTANDARD),presetis the empty string (""). - See Also:
TranscodePreset
-
recordingConfigurationArn
public final String recordingConfigurationArn()
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
- Returns:
- Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
-
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,
typewill returnChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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,
typewill returnChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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:
toBuilderin interfaceToCopyableBuilder<UpdateChannelRequest.Builder,UpdateChannelRequest>- Specified by:
toBuilderin classIvsRequest
-
builder
public static UpdateChannelRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateChannelRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-