Class S3DestinationConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.ivsrealtime.model.S3DestinationConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class S3DestinationConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>
A complex type that describes an S3 location where recorded videos will be stored.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceS3DestinationConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static S3DestinationConfiguration.Builderbuilder()List<String>encoderConfigurationArns()ARNs of the EncoderConfiguration resource.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEncoderConfigurationArns()For responses, this returns true if the service returned a value for the EncoderConfigurationArns property.inthashCode()booleanhasThumbnailConfigurations()For responses, this returns true if the service returned a value for the ThumbnailConfigurations property.RecordingConfigurationrecordingConfiguration()Array of maps, each of the formstring:string (key:value).Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends S3DestinationConfiguration.Builder>serializableBuilderClass()StringstorageConfigurationArn()ARN of the StorageConfiguration where recorded videos will be stored.List<CompositionThumbnailConfiguration>thumbnailConfigurations()A complex type that allows you to enable/disable the recording of thumbnails for a Composition and modify the interval at which thumbnails are generated for the live session.S3DestinationConfiguration.BuildertoBuilder()StringtoString()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
-
storageConfigurationArn
public final String storageConfigurationArn()
ARN of the StorageConfiguration where recorded videos will be stored.
- Returns:
- ARN of the StorageConfiguration where recorded videos will be stored.
-
hasEncoderConfigurationArns
public final boolean hasEncoderConfigurationArns()
For responses, this returns true if the service returned a value for the EncoderConfigurationArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
encoderConfigurationArns
public final List<String> encoderConfigurationArns()
ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
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
hasEncoderConfigurationArns()method.- Returns:
- ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
-
recordingConfiguration
public final RecordingConfiguration recordingConfiguration()
Array of maps, each of the form
string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.- Returns:
- Array of maps, each of the form
string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.
-
hasThumbnailConfigurations
public final boolean hasThumbnailConfigurations()
For responses, this returns true if the service returned a value for the ThumbnailConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
thumbnailConfigurations
public final List<CompositionThumbnailConfiguration> thumbnailConfigurations()
A complex type that allows you to enable/disable the recording of thumbnails for a Composition and modify the interval at which thumbnails are generated for the live session.
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
hasThumbnailConfigurations()method.- Returns:
- A complex type that allows you to enable/disable the recording of thumbnails for a Composition and modify the interval at which thumbnails are generated for the live session.
-
toBuilder
public S3DestinationConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>
-
builder
public static S3DestinationConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends S3DestinationConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-