Class: Azure::CustomerInsights::Mgmt::V2017_04_26::Models::LinkResourceFormat

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

Overview

The link resource format.

Instance Attribute Summary collapse

Attributes inherited from ProxyResource

#id, #name, #type

Class Method Summary collapse

Instance Attribute Details

#descriptionHash{String => String}

Returns Localized descriptions for the Link.

Returns:

  • (Hash{String => String})

    Localized descriptions for the Link.



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

def description
  @description
end

#display_nameHash{String => String}

Returns Localized display name for the Link.

Returns:

  • (Hash{String => String})

    Localized display name for the Link.



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

def display_name
  @display_name
end

Returns The link name.

Returns:

  • (String)

    The link name.



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

def link_name
  @link_name
end

#mappingsArray<TypePropertiesMapping>

between the source and target Types.

Returns:



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

def mappings
  @mappings
end

#operation_typeInstanceOperationType

supposed to create or delete instances if Link is NOT Reference Only. Possible values include: ‘Upsert’, ‘Delete’

Returns:



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

def operation_type
  @operation_type
end

#participant_property_referencesArray<ParticipantPropertyReference>

represent the participating profile.

Returns:



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

def participant_property_references
  @participant_property_references
end

#provisioning_stateProvisioningStates

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

Returns:



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

def provisioning_state
  @provisioning_state
end

#reference_onlyBoolean

This flag is ingored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.

Returns:

  • (Boolean)

    Indicating whether the link is reference only link.



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

def reference_only
  @reference_only
end

#source_entity_typeEntityType

‘None’, ‘Profile’, ‘Interaction’, ‘Relationship’

Returns:

  • (EntityType)

    Type of source entity. Possible values include:



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

def source_entity_type
  @source_entity_type
end

#source_entity_type_nameString

Returns Name of the source Entity Type.

Returns:

  • (String)

    Name of the source Entity Type.



30
31
32
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/link_resource_format.rb', line 30

def source_entity_type_name
  @source_entity_type_name
end

#target_entity_typeEntityType

‘None’, ‘Profile’, ‘Interaction’, ‘Relationship’

Returns:

  • (EntityType)

    Type of target entity. Possible values include:



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

def target_entity_type
  @target_entity_type
end

#target_entity_type_nameString

Returns Name of the target Entity Type.

Returns:

  • (String)

    Name of the target Entity Type.



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

def target_entity_type_name
  @target_entity_type_name
end

#tenant_idString

Returns The hub name.

Returns:

  • (String)

    The hub name.



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

def tenant_id
  @tenant_id
end

Class Method Details

.mapperObject

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



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
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
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/models/link_resource_format.rb', line 70

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'LinkResourceFormat',
    type: {
      name: 'Composite',
      class_name: 'LinkResourceFormat',
      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'
          }
        },
        tenant_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.tenantId',
          type: {
            name: 'String'
          }
        },
        link_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.linkName',
          type: {
            name: 'String'
          }
        },
        source_entity_type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.sourceEntityType',
          type: {
            name: 'Enum',
            module: 'EntityType'
          }
        },
        target_entity_type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.targetEntityType',
          type: {
            name: 'Enum',
            module: 'EntityType'
          }
        },
        source_entity_type_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.sourceEntityTypeName',
          type: {
            name: 'String'
          }
        },
        target_entity_type_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.targetEntityTypeName',
          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'
                }
            }
          }
        },
        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'
                }
            }
          }
        },
        mappings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.mappings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'TypePropertiesMappingElementType',
                type: {
                  name: 'Composite',
                  class_name: 'TypePropertiesMapping'
                }
            }
          }
        },
        participant_property_references: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.participantPropertyReferences',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ParticipantPropertyReferenceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ParticipantPropertyReference'
                }
            }
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        reference_only: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.referenceOnly',
          type: {
            name: 'Boolean'
          }
        },
        operation_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.operationType',
          type: {
            name: 'Enum',
            module: 'InstanceOperationType'
          }
        }
      }
    }
  }
end