software.amazon.awssdk.services.ivs.model

Class CreateRecordingConfigurationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRecordingConfigurationRequest.Builder,CreateRecordingConfigurationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRecordingConfigurationRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateRecordingConfigurationRequest.Builder	builder()
DestinationConfiguration	destinationConfiguration() A complex type that contains a destination configuration for where recorded video will be stored.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() Recording-configuration name.
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.
RenditionConfiguration	renditionConfiguration() Object that describes which renditions should be recorded for a stream.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRecordingConfigurationRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Array of 1-50 maps, each of the form string:string (key:value).
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.
CreateRecordingConfigurationRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

destinationConfiguration

public final DestinationConfiguration destinationConfiguration()

A complex type that contains a destination configuration for where recorded video will be stored.

Returns:

A complex type that contains a destination configuration for 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.

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

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:

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 CreateRecordingConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRecordingConfigurationRequest.Builder,CreateRecordingConfigurationRequest>

Specified by:

toBuilder in class IvsRequest

builder

public static CreateRecordingConfigurationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRecordingConfigurationRequest.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