Class Trigger
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Trigger.Builder,Trigger>
Determines when a function runs. Specify exactly one member.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Trigger.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FixedIntervalTriggerRun the function at a fixed interval of content.static TriggerfromFixedInterval(Consumer<FixedIntervalTrigger.Builder> fixedInterval) Create an instance of this class withfixedInterval()initialized to the given value.static TriggerfromFixedInterval(FixedIntervalTrigger fixedInterval) Create an instance of this class withfixedInterval()initialized to the given value.static TriggerfromPerClip(Consumer<ClipTrigger.Builder> perClip) Create an instance of this class withperClip()initialized to the given value.static TriggerfromPerClip(ClipTrigger perClip) Create an instance of this class withperClip()initialized to the given value.static TriggerfromPerScene(Consumer<SceneTrigger.Builder> perScene) Create an instance of this class withperScene()initialized to the given value.static TriggerfromPerScene(SceneTrigger perScene) Create an instance of this class withperScene()initialized to the given value.static TriggerfromPerShot(Consumer<ShotTrigger.Builder> perShot) Create an instance of this class withperShot()initialized to the given value.static TriggerfromPerShot(ShotTrigger perShot) Create an instance of this class withperShot()initialized to the given value.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final ClipTriggerperClip()Run the function once for each clip that an event clipping output detects.final SceneTriggerperScene()Run the function once for each scene boundary that a contextual metadata output reports.final ShotTriggerperShot()Run the function once for each shot that Elemental Inference detects.static Class<? extends Trigger.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.type()Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fixedInterval
Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
- Returns:
- Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
-
perShot
Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
- Returns:
- Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
-
perScene
Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
- Returns:
- Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
-
perClip
Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
- Returns:
- Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<Trigger.Builder,Trigger> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
fromFixedInterval
Create an instance of this class withfixedInterval()initialized to the given value.Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
- Parameters:
fixedInterval- Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
-
fromFixedInterval
Create an instance of this class withfixedInterval()initialized to the given value.Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
- Parameters:
fixedInterval- Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
-
fromPerShot
Create an instance of this class withperShot()initialized to the given value.Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
- Parameters:
perShot- Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
-
fromPerShot
Create an instance of this class withperShot()initialized to the given value.Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
- Parameters:
perShot- Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
-
fromPerScene
Create an instance of this class withperScene()initialized to the given value.Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
- Parameters:
perScene- Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
-
fromPerScene
Create an instance of this class withperScene()initialized to the given value.Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
- Parameters:
perScene- Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
-
fromPerClip
Create an instance of this class withperClip()initialized to the given value.Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
- Parameters:
perClip- Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
-
fromPerClip
Create an instance of this class withperClip()initialized to the given value.Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
- Parameters:
perClip- Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
-
type
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beTrigger.Type.UNKNOWN_TO_SDK_VERSIONif the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beTrigger.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set. -
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-