Package com.azure.analytics.synapse.artifacts.models

Class JsonFormat

java.lang.Object
com.azure.analytics.synapse.artifacts.models.DatasetStorageFormat
com.azure.analytics.synapse.artifacts.models.JsonFormat
public final class JsonFormat extends DatasetStorageFormat
The data stored in JSON format.

  • Constructor Details

    • JsonFormat

      public JsonFormat()

  • Method Details

    • getFilePattern

      public Object getFilePattern()
      Get the filePattern property: File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.
      Returns:
      the filePattern value.

    • setFilePattern

      public JsonFormat setFilePattern(Object filePattern)
      Set the filePattern property: File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.
      Parameters:
      filePattern - the filePattern value to set.
      Returns:
      the JsonFormat object itself.

    • getNestingSeparator

      public Object getNestingSeparator()
      Get the nestingSeparator property: The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).
      Returns:
      the nestingSeparator value.

    • setNestingSeparator

      public JsonFormat setNestingSeparator(Object nestingSeparator)
      Set the nestingSeparator property: The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).
      Parameters:
      nestingSeparator - the nestingSeparator value to set.
      Returns:
      the JsonFormat object itself.

    • getEncodingName

      public Object getEncodingName()
      Get the encodingName property: The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).
      Returns:
      the encodingName value.

    • setEncodingName

      public JsonFormat setEncodingName(Object encodingName)
      Set the encodingName property: The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).
      Parameters:
      encodingName - the encodingName value to set.
      Returns:
      the JsonFormat object itself.

    • getJsonNodeReference

      public Object getJsonNodeReference()
      Get the jsonNodeReference property: The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).
      Returns:
      the jsonNodeReference value.

    • setJsonNodeReference

      public JsonFormat setJsonNodeReference(Object jsonNodeReference)
      Set the jsonNodeReference property: The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).
      Parameters:
      jsonNodeReference - the jsonNodeReference value to set.
      Returns:
      the JsonFormat object itself.

    • getJsonPathDefinition

      public Object getJsonPathDefinition()
      Get the jsonPathDefinition property: The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).
      Returns:
      the jsonPathDefinition value.

    • setJsonPathDefinition

      public JsonFormat setJsonPathDefinition(Object jsonPathDefinition)
      Set the jsonPathDefinition property: The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).
      Parameters:
      jsonPathDefinition - the jsonPathDefinition value to set.
      Returns:
      the JsonFormat object itself.

    • setSerializer

      public JsonFormat setSerializer(Object serializer)
      Set the serializer property: Serializer. Type: string (or Expression with resultType string).
      Overrides:
      setSerializer in class DatasetStorageFormat
      Parameters:
      serializer - the serializer value to set.
      Returns:
      the DatasetStorageFormat object itself.

    • setDeserializer

      public JsonFormat setDeserializer(Object deserializer)
      Set the deserializer property: Deserializer. Type: string (or Expression with resultType string).
      Overrides:
      setDeserializer in class DatasetStorageFormat
      Parameters:
      deserializer - the deserializer value to set.
      Returns:
      the DatasetStorageFormat object itself.