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

Class ScheduleConfig

java.lang.Object

software.amazon.awssdk.services.kinesisvideo.model.ScheduleConfig

All Implemented Interfaces:

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

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

This API enables you to specify the duration that the camera, or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the DurationInMinutes attributes.

If the ScheduleConfig is not provided in the RecorderConfig, then the Edge Agent will always be set to recording mode.

If the ScheduleConfig is not provided in the UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScheduleConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ScheduleConfig.Builder	builder()
Integer	durationInSeconds()	The total duration to record the media.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	scheduleExpression()	The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduleConfig.Builder>	serializableBuilderClass()
ScheduleConfig.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

scheduleExpression

public final String scheduleExpression()

The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

Returns:

The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

durationInSeconds

public final Integer durationInSeconds()

The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

Returns:

The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

toBuilder

public ScheduleConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduleConfig.Builder,ScheduleConfig>

builder

public static ScheduleConfig.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo