Package software.amazon.awssdk.services.ivs.model

Class RecordingConfiguration

java.lang.Object
software.amazon.awssdk.services.ivs.model.RecordingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecordingConfiguration.Builder,RecordingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class RecordingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecordingConfiguration.Builder,RecordingConfiguration>

An object representing a configuration to record a channel stream.

See Also:

  • Method Details

    • arn

      public final String arn()

      Recording-configuration ARN.

      Returns:
      Recording-configuration ARN.

    • destinationConfiguration

      public final DestinationConfiguration destinationConfiguration()

      A complex type that contains information about where recorded video will be stored.

      Returns:
      A complex type that contains information about where recorded video will be stored.

    • name

      public final String name()

      Recording-configuration name. The value does not need to be unique.

      Returns:
      Recording-configuration name. The value does not need to be unique.

    • recordingReconnectWindowSeconds

      public final Integer recordingReconnectWindowSeconds()

      If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

      Returns:
      If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

    • renditionConfiguration

      public final RenditionConfiguration renditionConfiguration()

      Object that describes which renditions should be recorded for a stream.

      Returns:
      Object that describes which renditions should be recorded for a stream.

    • state

      public final RecordingConfigurationState state()

      Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

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

      Returns:
      Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
      See Also:

    • stateAsString

      public final String stateAsString()

      Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

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

      Returns:
      Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

    • thumbnailConfiguration

      public final ThumbnailConfiguration thumbnailConfiguration()

      A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

      Returns:
      A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

    • toBuilder

      public RecordingConfiguration.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<RecordingConfiguration.Builder,RecordingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static RecordingConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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