class Azure::CustomerInsights::Mgmt::V2017_01_01::Models::PropertyDefinition

Property definition.

Attributes

array_value_separator[RW]

@return [String] Array value separator for properties with isArray set.

data_source_precedence_rules[RW]

@return [Array<DataSourcePrecedence>] This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

enum_valid_values[RW]

@return [Array<ProfileEnumValidValuesFormat>] Describes valid values for an enum property.

field_name[RW]

@return [String] Name of the property.

field_type[RW]

@return [String] Type of the property.

is_array[RW]

@return [Boolean] Indicates if the property is actually an array of the fieldType above on the data api.

is_available_in_graph[RW]

@return [Boolean] Whether property is available in graph or not.

is_enum[RW]

@return [Boolean] Indicates if the property is an enum.

is_flag_enum[RW]

@return [Boolean] Indicates if the property is an flag enum.

is_image[RW]

@return [Boolean] Whether the property is an Image.

is_localized_string[RW]

@return [Boolean] Whether the property is a localized string.

is_name[RW]

@return [Boolean] Whether the property is a name or a part of name.

is_required[RW]

@return [Boolean] Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field.

max_length[RW]

@return [Integer] Max length of string. Used only if type is string.

property_id[RW]

@return [String] The ID associated with the property.

Public Class Methods

mapper() click to toggle source

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

# 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