software.amazon.awssdk.services.ivs.model

Class RecordingConfigurationSummary

java.lang.Object

software.amazon.awssdk.services.ivs.model.RecordingConfigurationSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RecordingConfigurationSummary.Builder,RecordingConfigurationSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class RecordingConfigurationSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecordingConfigurationSummary.Builder,RecordingConfigurationSummary>

Summary information about a RecordingConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecordingConfigurationSummary.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Recording-configuration ARN.
static RecordingConfigurationSummary.Builder	builder()
DestinationConfiguration	destinationConfiguration() A complex type that contains information about 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() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() An arbitrary string (a nickname) assigned to a recording configuration that helps the customer identify that resource.
List<SdkField<?>>	sdkFields()
static Class<? extends RecordingConfigurationSummary.Builder>	serializableBuilderClass()
RecordingConfigurationState	state() Indicates the current state of the recording configuration.
String	stateAsString() Indicates the current state of the recording configuration.
Map<String,String>	tags() Array of 1-50 maps, each of the form string:string (key:value).
RecordingConfigurationSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

Recording-configuration ARN.

Returns:

Recording-configuration ARN.

name

public final String name()

An arbitrary string (a nickname) assigned to a recording configuration that helps the customer identify that resource. The value does not need to be unique.

Returns:

An arbitrary string (a nickname) assigned to a recording configuration that helps the customer identify that resource. The value does not need to be unique.

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.

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:

RecordingConfigurationState

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:

RecordingConfigurationState

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

Array of 1-50 maps, each of the form string:string (key:value).

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

You can use hasTags() to see if a value was sent in this field.

Returns:

Array of 1-50 maps, each of the form string:string (key:value).

toBuilder

public RecordingConfigurationSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecordingConfigurationSummary.Builder,RecordingConfigurationSummary>

builder

public static RecordingConfigurationSummary.Builder builder()

serializableBuilderClass

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

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo