Class: Azure::CustomerInsights::Mgmt::V2017_04_26::Models::InteractionResourceFormat

Inherits:
ProxyResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb

Overview

The interaction resource format.

Instance Attribute Summary collapse

Attributes inherited from ProxyResource

#id, #name, #type

Class Method Summary collapse

Instance Attribute Details

#api_entity_set_name ⇒ String

set name for the entity Type being refered in this object.

Returns:

  • (String) —

    The api entity set name. This becomes the odata entity



44
45
46
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 44

def api_entity_set_name
  @api_entity_set_name
end

#attributes ⇒ Hash{String => Array<String>}

Returns The attributes for the Type.

Returns:

  • (Hash{String => Array<String>}) —

    The attributes for the Type.



16
17
18
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 16

def attributes
  @attributes
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:



94
95
96
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 94

def data_source_precedence_rules
  @data_source_precedence_rules
end

#data_source_reference_id ⇒ String

Returns The data source reference id.

Returns:

  • (String) —

    The data source reference id.



111
112
113
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 111

def data_source_reference_id
  @data_source_reference_id
end

#data_source_type ⇒ DataSourceType

‘Connector’, ‘LinkInteraction’, ‘SystemDefault’

Returns:



101
102
103
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 101

def data_source_type
  @data_source_type
end

#description ⇒ Hash{String => String}

property.

Returns:

  • (Hash{String => String}) —

    Localized descriptions for the



20
21
22
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 20

def description
  @description
end

#display_name ⇒ Hash{String => String}

property.

Returns:

  • (Hash{String => String}) —

    Localized display names for the



24
25
26
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 24

def display_name
  @display_name
end

#entity_type ⇒ EntityTypes

‘Profile’, ‘Interaction’, ‘Relationship’

Returns:

  • (EntityTypes) —

    Type of entity. Possible values include: ‘None’,



48
49
50
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 48

def entity_type
  @entity_type
end

#fields ⇒ Array<PropertyDefinition>

Returns The properties of the Profile.

Returns:



51
52
53
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 51

def fields
  @fields
end

#id_property_names ⇒ Array<String>

uniquely identify an interaction instance.

Returns:

  • (Array<String>) —

    The id property names. Properties which



80
81
82
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 80

def id_property_names
  @id_property_names
end

#instances_count ⇒ Integer

Returns The instance count.

Returns:

  • (Integer) —

    The instance count.



54
55
56
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 54

def instances_count
  @instances_count
end

#interaction_resource_format_id ⇒ Integer

Returns The data source ID.

Returns:

  • (Integer) —

    The data source ID.



108
109
110
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 108

def interaction_resource_format_id
  @interaction_resource_format_id
end

#interaction_resource_format_name ⇒ String

Returns The data source name.

Returns:

  • (String) —

    The data source name



97
98
99
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 97

def interaction_resource_format_name
  @interaction_resource_format_name
end

#is_activity ⇒ Boolean

during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level.

Returns:

  • (Boolean) —

    An interaction can be tagged as an activity only



117
118
119
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 117

def is_activity
  @is_activity
end

#large_image ⇒ String

EntityType.

Returns:

  • (String) —

    Large Image associated with the Property or



40
41
42
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 40

def large_image
  @large_image
end

#last_changed_utc ⇒ DateTime

Returns The last changed time for the type definition.

Returns:

  • (DateTime) —

    The last changed time for the type definition.



57
58
59
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 57

def last_changed_utc
  @last_changed_utc
end

#localized_attributes ⇒ Hash{String => Hash{String => String}}

attributes for the Type.

Returns:

  • (Hash{String => Hash{String => String}}) —

    Any custom localized



28
29
30
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 28

def localized_attributes
  @localized_attributes
end

#medium_image ⇒ String

EntityType.

Returns:

  • (String) —

    Medium Image associated with the Property or



36
37
38
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 36

def medium_image
  @medium_image
end

#participant_profiles ⇒ Array<Participant>

interaction.

Returns:

  • (Array<Participant>) —

    Profiles that participated in the



84
85
86
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 84

def participant_profiles
  @participant_profiles
end

#primary_participant_profile_property_name ⇒ String

interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName.

Returns:

  • (String) —

    The primary participant property name for an



89
90
91
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 89

def primary_participant_profile_property_name
  @primary_participant_profile_property_name
end

#provisioning_state ⇒ ProvisioningStates

include: ‘Provisioning’, ‘Succeeded’, ‘Expiring’, ‘Deleting’, ‘HumanIntervention’, ‘Failed’

Returns:



62
63
64
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 62

def provisioning_state
  @provisioning_state
end

#schema_item_type_link ⇒ String

suggest semantic models.

Returns:

  • (String) —

    The schema org link. This helps ACI identify and



66
67
68
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 66

def schema_item_type_link
  @schema_item_type_link
end

#small_image ⇒ String

EntityType.

Returns:

  • (String) —

    Small Image associated with the Property or



32
33
34
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 32

def small_image
  @small_image
end

#status ⇒ Status

‘None’, ‘Active’, ‘Deleted’

Returns:

  • (Status) —

    The data source status. Possible values include:



105
106
107
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 105

def status
  @status
end

#tenant_id ⇒ String

Returns The hub name.

Returns:

  • (String) —

    The hub name.



69
70
71
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 69

def tenant_id
  @tenant_id
end

#timestamp_field_name ⇒ String

the interaction or profile update happened.

Returns:

  • (String) —

    The timestamp property name. Represents the time when



73
74
75
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 73

def timestamp_field_name
  @timestamp_field_name
end

#type_name ⇒ String

Returns The name of the entity.

Returns:

  • (String) —

    The name of the entity.



76
77
78
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 76

def type_name
  @type_name
end

Class Method Details

.mapper ⇒ Object

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



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/interaction_resource_format.rb', line 124

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'InteractionResourceFormat',
    type: {
      name: 'Composite',
      class_name: 'InteractionResourceFormat',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        attributes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.attributes',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ArrayElementType',
                type: {
                  name: 'Sequence',
                  element: {
                      client_side_validation: true,
                      required: false,
                      serialized_name: 'StringElementType',
                      type: {
                        name: 'String'
                      }
                  }
                }
            }
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        localized_attributes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.localizedAttributes',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'HashElementType',
                type: {
                  name: 'Dictionary',
                  value: {
                      client_side_validation: true,
                      required: false,
                      serialized_name: 'StringElementType',
                      type: {
                        name: 'String'
                      }
                  }
                }
            }
          }
        },
        small_image: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.smallImage',
          type: {
            name: 'String'
          }
        },
        medium_image: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.mediumImage',
          type: {
            name: 'String'
          }
        },
        large_image: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.largeImage',
          type: {
            name: 'String'
          }
        },
        api_entity_set_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.apiEntitySetName',
          type: {
            name: 'String'
          }
        },
        entity_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.entityType',
          type: {
            name: 'Enum',
            module: 'EntityTypes'
          }
        },
        fields: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.fields',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PropertyDefinitionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PropertyDefinition'
                }
            }
          }
        },
        instances_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.instancesCount',
          type: {
            name: 'Number'
          }
        },
        last_changed_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastChangedUtc',
          type: {
            name: 'DateTime'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        schema_item_type_link: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.schemaItemTypeLink',
          type: {
            name: 'String'
          }
        },
        tenant_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.tenantId',
          type: {
            name: 'String'
          }
        },
        timestamp_field_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.timestampFieldName',
          type: {
            name: 'String'
          }
        },
        type_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.typeName',
          type: {
            name: 'String'
          }
        },
        id_property_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.idPropertyNames',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        participant_profiles: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.participantProfiles',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ParticipantElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Participant'
                }
            }
          }
        },
        primary_participant_profile_property_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.primaryParticipantProfilePropertyName',
          type: {
            name: 'String'
          }
        },
        data_source_precedence_rules: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.dataSourcePrecedenceRules',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'DataSourcePrecedenceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'DataSourcePrecedence'
                }
            }
          }
        },
        interaction_resource_format_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultDataSource.name',
          type: {
            name: 'String'
          }
        },
        data_source_type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultDataSource.dataSourceType',
          type: {
            name: 'String'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultDataSource.status',
          type: {
            name: 'String'
          }
        },
        interaction_resource_format_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultDataSource.id',
          type: {
            name: 'Number'
          }
        },
        data_source_reference_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultDataSource.dataSourceReferenceId',
          type: {
            name: 'String'
          }
        },
        is_activity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isActivity',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end