RecordingConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ivs.model.RecordingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RecordingConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object representing a configuration to record a channel stream.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RecordingConfiguration()

Constructors
Constructor and Description
`RecordingConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecordingConfiguration`	`addTagsEntry(String key, String value)` Add a single Tags entry
`RecordingConfiguration`	`clearTagsEntries()` Removes all the entries added into Tags.
`RecordingConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Recording-configuration ARN.
`DestinationConfiguration`	`getDestinationConfiguration()` A complex type that contains information about where recorded video will be stored.
`String`	`getName()` Recording-configuration name.
`Integer`	`getRecordingReconnectWindowSeconds()` If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
`String`	`getState()` Indicates the current state of the recording configuration.
`Map<String,String>`	`getTags()` Tags attached to the resource.
`ThumbnailConfiguration`	`getThumbnailConfiguration()` 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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` Recording-configuration ARN.
`void`	`setDestinationConfiguration(DestinationConfiguration destinationConfiguration)` A complex type that contains information about where recorded video will be stored.
`void`	`setName(String name)` Recording-configuration name.
`void`	`setRecordingReconnectWindowSeconds(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.
`void`	`setState(String state)` Indicates the current state of the recording configuration.
`void`	`setTags(Map<String,String> tags)` Tags attached to the resource.
`void`	`setThumbnailConfiguration(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.
`String`	`toString()` Returns a string representation of this object.
`RecordingConfiguration`	`withArn(String arn)` Recording-configuration ARN.
`RecordingConfiguration`	`withDestinationConfiguration(DestinationConfiguration destinationConfiguration)` A complex type that contains information about where recorded video will be stored.
`RecordingConfiguration`	`withName(String name)` Recording-configuration name.
`RecordingConfiguration`	`withRecordingReconnectWindowSeconds(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.
`RecordingConfiguration`	`withState(RecordingConfigurationState state)` Indicates the current state of the recording configuration.
`RecordingConfiguration`	`withState(String state)` Indicates the current state of the recording configuration.
`RecordingConfiguration`	`withTags(Map<String,String> tags)` Tags attached to the resource.
`RecordingConfiguration`	`withThumbnailConfiguration(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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecordingConfiguration
```
public RecordingConfiguration()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    Recording-configuration ARN.
    
    Parameters:
    
    arn - Recording-configuration ARN.
  - getArn
```
public String getArn()
```
    Recording-configuration ARN.
    
    Returns:
    
    Recording-configuration ARN.
  - withArn
```
public RecordingConfiguration withArn(String arn)
```
    Recording-configuration ARN.
    
    Parameters:
    
    arn - Recording-configuration ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationConfiguration
```
public void setDestinationConfiguration(DestinationConfiguration destinationConfiguration)
```
    A complex type that contains information about where recorded video will be stored.
    
    Parameters:
    
    destinationConfiguration - A complex type that contains information about where recorded video will be stored.
  - getDestinationConfiguration
```
public DestinationConfiguration getDestinationConfiguration()
```
    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.
  - withDestinationConfiguration
```
public RecordingConfiguration withDestinationConfiguration(DestinationConfiguration destinationConfiguration)
```
    A complex type that contains information about where recorded video will be stored.
    
    Parameters:
    
    destinationConfiguration - A complex type that contains information about where recorded video will be stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    Recording-configuration name. The value does not need to be unique.
    
    Parameters:
    
    name - Recording-configuration name. The value does not need to be unique.
  - getName
```
public String getName()
```
    Recording-configuration name. The value does not need to be unique.
    
    Returns:
    
    Recording-configuration name. The value does not need to be unique.
  - withName
```
public RecordingConfiguration withName(String name)
```
    Recording-configuration name. The value does not need to be unique.
    
    Parameters:
    
    name - Recording-configuration name. The value does not need to be unique.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecordingReconnectWindowSeconds
```
public void setRecordingReconnectWindowSeconds(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.
    
    Parameters:
    
    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.
  - getRecordingReconnectWindowSeconds
```
public Integer getRecordingReconnectWindowSeconds()
```
    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.
  - withRecordingReconnectWindowSeconds
```
public RecordingConfiguration withRecordingReconnectWindowSeconds(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    
    Parameters:
    
    state - Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    
    See Also:
    
    RecordingConfigurationState
  - getState
```
public String getState()
```
    Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    
    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:
    
    RecordingConfigurationState
  - withState
```
public RecordingConfiguration withState(String state)
```
    Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    
    Parameters:
    
    state - Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RecordingConfigurationState
  - withState
```
public RecordingConfiguration withState(RecordingConfigurationState state)
```
    Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    
    Parameters:
    
    state - Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RecordingConfigurationState
  - getTags
```
public Map<String,String> getTags()
```
    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.
    
    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.
  - setTags
```
public void setTags(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.
    
    Parameters:
    
    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.
  - withTags
```
public RecordingConfiguration withTags(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public RecordingConfiguration addTagsEntry(String key,
                                           String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public RecordingConfiguration clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThumbnailConfiguration
```
public void setThumbnailConfiguration(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.
    
    Parameters:
    
    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.
  - getThumbnailConfiguration
```
public ThumbnailConfiguration getThumbnailConfiguration()
```
    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.
  - withThumbnailConfiguration
```
public RecordingConfiguration withThumbnailConfiguration(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RecordingConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class RecordingConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordingConfiguration

Method Detail

setArn

getArn

withArn

setDestinationConfiguration

getDestinationConfiguration

withDestinationConfiguration

setName

getName

withName

setRecordingReconnectWindowSeconds

getRecordingReconnectWindowSeconds

withRecordingReconnectWindowSeconds

setState

getState

withState

withState

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setThumbnailConfiguration

getThumbnailConfiguration

withThumbnailConfiguration

toString

equals

hashCode

clone

marshall