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

Interface DeletionConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DeletionConfig.Builder,DeletionConfig>, SdkBuilder<DeletionConfig.Builder,DeletionConfig>, SdkPojo

Enclosing class:

DeletionConfig

public static interface DeletionConfig.Builder
extends SdkPojo, CopyableBuilder<DeletionConfig.Builder,DeletionConfig>

Method Summary

Modifier and Type	Method	Description
DeletionConfig.Builder	deleteAfterUpload(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.
DeletionConfig.Builder	edgeRetentionInHours(Integer edgeRetentionInHours)	The number of hours that you want to retain the data in the stream on the Edge Agent.
default DeletionConfig.Builder	localSizeConfig(Consumer<LocalSizeConfig.Builder> localSizeConfig)	The value of the local size required in order to delete the edge configuration.
DeletionConfig.Builder	localSizeConfig(LocalSizeConfig localSizeConfig)	The value of the local size required in order to delete the edge configuration.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

edgeRetentionInHours

DeletionConfig.Builder edgeRetentionInHours(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

localSizeConfig

DeletionConfig.Builder localSizeConfig(LocalSizeConfig localSizeConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

localSizeConfig

default DeletionConfig.Builder localSizeConfig(Consumer<LocalSizeConfig.Builder> localSizeConfig)

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

This is a convenience method that creates an instance of the LocalSizeConfig.Builder avoiding the need to create one manually via LocalSizeConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to localSizeConfig(LocalSizeConfig).

Parameters:

localSizeConfig - a consumer that will call methods on LocalSizeConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

localSizeConfig(LocalSizeConfig)

deleteAfterUpload

DeletionConfig.Builder deleteAfterUpload(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.