Package 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("software.amazon.awssdk:codegen") public final class UpdateChannelRequest extends IvsRequest implements ToCopyableBuilder<UpdateChannelRequest.Builder,UpdateChannelRequest>

  • Method Details

    • 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 and SRT ingest. Default: false.

      Returns:
      Whether the channel allows insecure RTMP and SRT 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.

      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.
      See Also:

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

      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.
      See Also:

    • 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_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:

    • 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:

    • 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, 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:

    • 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:

    • toBuilder

      public UpdateChannelRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateChannelRequest.Builder,UpdateChannelRequest>
      Specified by:
      toBuilder in class IvsRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.