Class: Azure::DataFactory::Mgmt::V2017_09_01_preview::Models::JsonFormat

Inherits:
DatasetStorageFormat show all
Includes:
MsRestAzure
Defined in:
lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb

Overview

The data stored in JSON format.

Instance Attribute Summary collapse

Attributes inherited from DatasetStorageFormat

#additional_properties, #deserializer, #serializer

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeJsonFormat

Returns a new instance of JsonFormat.



16
17
18
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb', line 16

def initialize
  @type = "JsonFormat"
end

Instance Attribute Details

#encoding_nameObject

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: go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).

Returns:

  • The code page name of the preferred encoding. If not provided,



38
39
40
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb', line 38

def encoding_name
  @encoding_name
end

#file_patternJsonFormatFilePattern

specific, the way of separating a collection of JSON objects. The default value is ‘setOfObjects’. It is case-sensitive. Possible values include: ‘setOfObjects’, ‘arrayOfObjects’

Returns:



26
27
28
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb', line 26

def file_pattern
  @file_pattern
end

#json_node_referenceObject

Example: “$.ArrayPath”. Type: string (or Expression with resultType string).

Returns:

  • The JSONPath of the JSON array element to be flattened.



43
44
45
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb', line 43

def json_node_reference
  @json_node_reference
end

#json_path_definitionObject

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: “$.Column1Path”, “Column2”: “Column2PathInArray”. Type: object (or Expression with resultType object).

Returns:

  • The JSONPath definition for each column mapping with a



51
52
53
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb', line 51

def json_path_definition
  @json_path_definition
end

#nesting_separatorObject

‘.’ (dot). Type: string (or Expression with resultType string).

Returns:

  • The character used to separate nesting levels. Default value is



30
31
32
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb', line 30

def nesting_separator
  @nesting_separator
end

#typeObject

Returns the value of attribute type.



20
21
22
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb', line 20

def type
  @type
end

Class Method Details

.mapperObject

Mapper for JsonFormat class as Ruby Hash. This will be used for serialization/deserialization.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/models/json_format.rb', line 58

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'JsonFormat',
    type: {
      name: 'Composite',
      class_name: 'JsonFormat',
      model_properties: {
        additional_properties: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        },
        serializer: {
          client_side_validation: true,
          required: false,
          serialized_name: 'serializer',
          type: {
            name: 'Object'
          }
        },
        deserializer: {
          client_side_validation: true,
          required: false,
          serialized_name: 'deserializer',
          type: {
            name: 'Object'
          }
        },
        type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        file_pattern: {
          client_side_validation: true,
          required: false,
          serialized_name: 'filePattern',
          type: {
            name: 'String'
          }
        },
        nesting_separator: {
          client_side_validation: true,
          required: false,
          serialized_name: 'nestingSeparator',
          type: {
            name: 'Object'
          }
        },
        encoding_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'encodingName',
          type: {
            name: 'Object'
          }
        },
        json_node_reference: {
          client_side_validation: true,
          required: false,
          serialized_name: 'jsonNodeReference',
          type: {
            name: 'Object'
          }
        },
        json_path_definition: {
          client_side_validation: true,
          required: false,
          serialized_name: 'jsonPathDefinition',
          type: {
            name: 'Object'
          }
        }
      }
    }
  }
end