Class JsonFieldWithDefault

java.lang.Object
com.azure.resourcemanager.eventgrid.models.JsonFieldWithDefault

public final class JsonFieldWithDefault extends Object
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject', 'eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the defaultValue property: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
    Get the sourceField property: Name of a field in the input event schema that's to be used as the source of a mapping.
    void
    Validates the instance.
    withDefaultValue(String defaultValue)
    Set the defaultValue property: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
    withSourceField(String sourceField)
    Set the sourceField property: Name of a field in the input event schema that's to be used as the source of a mapping.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • JsonFieldWithDefault

      public JsonFieldWithDefault()
  • Method Details

    • sourceField

      public String sourceField()
      Get the sourceField property: Name of a field in the input event schema that's to be used as the source of a mapping.
      Returns:
      the sourceField value.
    • withSourceField

      public JsonFieldWithDefault withSourceField(String sourceField)
      Set the sourceField property: Name of a field in the input event schema that's to be used as the source of a mapping.
      Parameters:
      sourceField - the sourceField value to set.
      Returns:
      the JsonFieldWithDefault object itself.
    • defaultValue

      public String defaultValue()
      Get the defaultValue property: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
      Returns:
      the defaultValue value.
    • withDefaultValue

      public JsonFieldWithDefault withDefaultValue(String defaultValue)
      Set the defaultValue property: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
      Parameters:
      defaultValue - the defaultValue value to set.
      Returns:
      the JsonFieldWithDefault object itself.
    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.