Package software.amazon.awssdk.services.kinesisvideo.model

Class DeletionConfig

java.lang.Object

software.amazon.awssdk.services.kinesisvideo.model.DeletionConfig

All Implemented Interfaces:

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

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

The configuration details required to delete the connection of the stream from the Edge Agent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeletionConfig.Builder

Method Summary

Modifier and Type	Method	Description
static DeletionConfig.Builder	builder()
Boolean	deleteAfterUpload()	The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud.
Integer	edgeRetentionInHours()	The number of hours that you want to retain the data in the stream on the Edge Agent.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LocalSizeConfig	localSizeConfig()	The value of the local size required in order to delete the edge configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends DeletionConfig.Builder>	serializableBuilderClass()
DeletionConfig.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

edgeRetentionInHours

public final Integer edgeRetentionInHours()

The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.

Returns:

The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.

localSizeConfig

public final LocalSizeConfig localSizeConfig()

The value of the local size required in order to delete the edge configuration.

Returns:

The value of the local size required in order to delete the edge configuration.

deleteAfterUpload

public final Boolean deleteAfterUpload()

The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached.

Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.

Returns:

The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached.

Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.

toBuilder

public DeletionConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeletionConfig.Builder,DeletionConfig>

builder

public static DeletionConfig.Builder builder()

serializableBuilderClass

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