Class ContextualMetadataConfig

java.lang.Object
software.amazon.awssdk.services.elementalinference.model.ContextualMetadataConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContextualMetadataConfig.Builder,ContextualMetadataConfig>

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

The output configuration settings for the contextual metadata feature. Use this structure when the feed output generates metadata that describes the media content.

See Also:
  • Method Details

    • summaryGeneration

      public final SummaryGenerationMode summaryGeneration()

      Specifies whether Elemental Inference generates a descriptive summary of the media content for this output, along with the objects and actions that it detects. This setting is independent of extendedAnalysis.

      Valid values:

      • ENABLED (default) – Elemental Inference populates the summary, objects, and actions fields, along with the IAB taxonomy and GARM suitability classifications.

      • DISABLED – Elemental Inference doesn't populate the summary, objects, and actions fields.

      If the service returns an enum value that is not available in the current SDK version, summaryGeneration will return SummaryGenerationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from summaryGenerationAsString().

      Returns:
      Specifies whether Elemental Inference generates a descriptive summary of the media content for this output, along with the objects and actions that it detects. This setting is independent of extendedAnalysis.

      Valid values:

      • ENABLED (default) – Elemental Inference populates the summary, objects, and actions fields, along with the IAB taxonomy and GARM suitability classifications.

      • DISABLED – Elemental Inference doesn't populate the summary, objects, and actions fields.

      See Also:
    • summaryGenerationAsString

      public final String summaryGenerationAsString()

      Specifies whether Elemental Inference generates a descriptive summary of the media content for this output, along with the objects and actions that it detects. This setting is independent of extendedAnalysis.

      Valid values:

      • ENABLED (default) – Elemental Inference populates the summary, objects, and actions fields, along with the IAB taxonomy and GARM suitability classifications.

      • DISABLED – Elemental Inference doesn't populate the summary, objects, and actions fields.

      If the service returns an enum value that is not available in the current SDK version, summaryGeneration will return SummaryGenerationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from summaryGenerationAsString().

      Returns:
      Specifies whether Elemental Inference generates a descriptive summary of the media content for this output, along with the objects and actions that it detects. This setting is independent of extendedAnalysis.

      Valid values:

      • ENABLED (default) – Elemental Inference populates the summary, objects, and actions fields, along with the IAB taxonomy and GARM suitability classifications.

      • DISABLED – Elemental Inference doesn't populate the summary, objects, and actions fields.

      See Also:
    • extendedAnalysis

      public final ExtendedAnalysisMode extendedAnalysis()

      Specifies whether Elemental Inference generates extended analysis of the media content for this output. Extended analysis identifies the people, environments, brands, and on-screen text in the media content. This setting is independent of summaryGeneration.

      Valid values:

      • ENABLED (default) – Elemental Inference populates the people, environments, brands, and on-screen text fields.

      • DISABLED – Elemental Inference doesn't populate the people, environments, brands, and on-screen text fields.

      If you specify customQuestions, you must set this property to DISABLED.

      If the service returns an enum value that is not available in the current SDK version, extendedAnalysis will return ExtendedAnalysisMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from extendedAnalysisAsString().

      Returns:
      Specifies whether Elemental Inference generates extended analysis of the media content for this output. Extended analysis identifies the people, environments, brands, and on-screen text in the media content. This setting is independent of summaryGeneration.

      Valid values:

      • ENABLED (default) – Elemental Inference populates the people, environments, brands, and on-screen text fields.

      • DISABLED – Elemental Inference doesn't populate the people, environments, brands, and on-screen text fields.

      If you specify customQuestions, you must set this property to DISABLED.

      See Also:
    • extendedAnalysisAsString

      public final String extendedAnalysisAsString()

      Specifies whether Elemental Inference generates extended analysis of the media content for this output. Extended analysis identifies the people, environments, brands, and on-screen text in the media content. This setting is independent of summaryGeneration.

      Valid values:

      • ENABLED (default) – Elemental Inference populates the people, environments, brands, and on-screen text fields.

      • DISABLED – Elemental Inference doesn't populate the people, environments, brands, and on-screen text fields.

      If you specify customQuestions, you must set this property to DISABLED.

      If the service returns an enum value that is not available in the current SDK version, extendedAnalysis will return ExtendedAnalysisMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from extendedAnalysisAsString().

      Returns:
      Specifies whether Elemental Inference generates extended analysis of the media content for this output. Extended analysis identifies the people, environments, brands, and on-screen text in the media content. This setting is independent of summaryGeneration.

      Valid values:

      • ENABLED (default) – Elemental Inference populates the people, environments, brands, and on-screen text fields.

      • DISABLED – Elemental Inference doesn't populate the people, environments, brands, and on-screen text fields.

      If you specify customQuestions, you must set this property to DISABLED.

      See Also:
    • customQuestions

      public final CustomQuestionsConfig customQuestions()

      The question sets that you ask Elemental Inference about each shot, each scene, or both, in this output.

      If you specify customQuestions, you must also set extendedAnalysis to DISABLED. If you omit extendedAnalysis, it defaults to ENABLED, and the request fails.

      While a feed references a version of a question set, you can't delete that version or the question set.

      Returns:
      The question sets that you ask Elemental Inference about each shot, each scene, or both, in this output.

      If you specify customQuestions, you must also set extendedAnalysis to DISABLED. If you omit extendedAnalysis, it defaults to ENABLED, and the request fails.

      While a feed references a version of a question set, you can't delete that version or the question set.

    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ContextualMetadataConfig.Builder,ContextualMetadataConfig>
      Returns:
      a builder for type T
    • builder

      public static ContextualMetadataConfig.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ContextualMetadataConfig.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.