Class: Azure::CustomerInsights::Mgmt::V2017_01_01::Models::PropertyDefinition

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb

Overview

Property definition.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#array_value_separator ⇒ String

Returns Array value separator for properties with isArray set.

Returns:

  • (String) —

    Array value separator for properties with isArray set.



16
17
18
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 16

def array_value_separator
  @array_value_separator
end

#data_source_precedence_rules ⇒ Array<DataSourcePrecedence>

modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

Returns:



68
69
70
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 68

def data_source_precedence_rules
  @data_source_precedence_rules
end

#enum_valid_values ⇒ Array<ProfileEnumValidValuesFormat>

for an enum property.

Returns:



20
21
22
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 20

def enum_valid_values
  @enum_valid_values
end

#field_name ⇒ String

Returns Name of the property.

Returns:

  • (String) —

    Name of the property.



23
24
25
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 23

def field_name
  @field_name
end

#field_type ⇒ String

Returns Type of the property.

Returns:

  • (String) —

    Type of the property.



26
27
28
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 26

def field_type
  @field_type
end

#is_array ⇒ Boolean

fieldType above on the data api.

Returns:

  • (Boolean) —

    Indicates if the property is actually an array of the



30
31
32
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 30

def is_array
  @is_array
end

#is_available_in_graph ⇒ Boolean

Returns Whether property is available in graph or not.

Returns:

  • (Boolean) —

    Whether property is available in graph or not.



63
64
65
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 63

def is_available_in_graph
  @is_available_in_graph
end

#is_enum ⇒ Boolean

Returns Indicates if the property is an enum.

Returns:

  • (Boolean) —

    Indicates if the property is an enum.



33
34
35
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 33

def is_enum
  @is_enum
end

#is_flag_enum ⇒ Boolean

Returns Indicates if the property is an flag enum.

Returns:

  • (Boolean) —

    Indicates if the property is an flag enum.



36
37
38
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 36

def is_flag_enum
  @is_flag_enum
end

#is_image ⇒ Boolean

Returns Whether the property is an Image.

Returns:

  • (Boolean) —

    Whether the property is an Image.



39
40
41
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 39

def is_image
  @is_image
end

#is_localized_string ⇒ Boolean

Returns Whether the property is a localized string.

Returns:

  • (Boolean) —

    Whether the property is a localized string.



42
43
44
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 42

def is_localized_string
  @is_localized_string
end

#is_name ⇒ Boolean

Returns Whether the property is a name or a part of name.

Returns:

  • (Boolean) —

    Whether the property is a name or a part of name.



45
46
47
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 45

def is_name
  @is_name
end

#is_required ⇒ Boolean

IsRequired field only for Intercation. Profile Instance will not check for required field.

Returns:

  • (Boolean) —

    Whether property value is required on instances,



50
51
52
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 50

def is_required
  @is_required
end

#max_length ⇒ Integer

Returns Max length of string. Used only if type is string.

Returns:

  • (Integer) —

    Max length of string. Used only if type is string.



60
61
62
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 60

def max_length
  @max_length
end

#property_id ⇒ String

Returns The ID associated with the property.

Returns:

  • (String) —

    The ID associated with the property.



53
54
55
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 53

def property_id
  @property_id
end

#schema_item_prop_link ⇒ String

property.

Returns:

  • (String) —

    URL encoded schema.org item prop link for the



57
58
59
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 57

def schema_item_prop_link
  @schema_item_prop_link
end

Class Method Details

.mapper ⇒ Object

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



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/models/property_definition.rb', line 75

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'PropertyDefinition',
    type: {
      name: 'Composite',
      class_name: 'PropertyDefinition',
      model_properties: {
        array_value_separator: {
          client_side_validation: true,
          required: false,
          serialized_name: 'arrayValueSeparator',
          type: {
            name: 'String'
          }
        },
        enum_valid_values: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enumValidValues',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ProfileEnumValidValuesFormatElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ProfileEnumValidValuesFormat'
                }
            }
          }
        },
        field_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'fieldName',
          type: {
            name: 'String'
          }
        },
        field_type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'fieldType',
          type: {
            name: 'String'
          }
        },
        is_array: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isArray',
          type: {
            name: 'Boolean'
          }
        },
        is_enum: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isEnum',
          type: {
            name: 'Boolean'
          }
        },
        is_flag_enum: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isFlagEnum',
          type: {
            name: 'Boolean'
          }
        },
        is_image: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isImage',
          type: {
            name: 'Boolean'
          }
        },
        is_localized_string: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isLocalizedString',
          type: {
            name: 'Boolean'
          }
        },
        is_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isName',
          type: {
            name: 'Boolean'
          }
        },
        is_required: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isRequired',
          type: {
            name: 'Boolean'
          }
        },
        property_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'propertyId',
          type: {
            name: 'String'
          }
        },
        schema_item_prop_link: {
          client_side_validation: true,
          required: false,
          serialized_name: 'schemaItemPropLink',
          type: {
            name: 'String'
          }
        },
        max_length: {
          client_side_validation: true,
          required: false,
          serialized_name: 'maxLength',
          type: {
            name: 'Number'
          }
        },
        is_available_in_graph: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isAvailableInGraph',
          type: {
            name: 'Boolean'
          }
        },
        data_source_precedence_rules: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'dataSourcePrecedenceRules',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'DataSourcePrecedenceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'DataSourcePrecedence'
                }
            }
          }
        }
      }
    }
  }
end