class Azure::CustomerInsights::Mgmt::V2017_01_01::Models::InteractionResourceFormat

The interaction resource format.

Attributes

api_entity_set_name[RW]

@return [String] The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object.

attributes[RW]

@return [Hash{String => Array<String>}] The attributes for the Type.

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.

data_source_reference_id[RW]

@return [String] The data source reference id.

data_source_type[RW]

@return [DataSourceType] The data source type. Possible values include: 'Connector', 'LinkInteraction', 'SystemDefault'

description[RW]

@return [Hash{String => String}] Localized descriptions for the property.

display_name[RW]

@return [Hash{String => String}] Localized display names for the property.

entity_type[RW]

@return [EntityTypes] Type of entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

fields[RW]

@return [Array<PropertyDefinition>] The properties of the Profile.

id_property_names[RW]

@return [Array<String>] The id property names. Properties which uniquely identify an interaction instance.

instances_count[RW]

@return [Integer] The instance count.

interaction_resource_format_id[RW]

@return [Integer] The data source ID.

interaction_resource_format_name[RW]

@return [String] The data source name

is_activity[RW]

@return [Boolean] An interaction can be tagged as an activity only 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.

large_image[RW]

@return [String] Large Image associated with the Property or EntityType.

last_changed_utc[RW]

@return [DateTime] The last changed time for the type definition.

localized_attributes[RW]

@return [Hash{String => Hash{String => String}}] Any custom localized attributes for the Type.

medium_image[RW]

@return [String] Medium Image associated with the Property or EntityType.

participant_profiles[RW]

@return [Array<Participant>] Profiles that participated in the interaction.

primary_participant_profile_property_name[RW]

@return [String] The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName.

provisioning_state[RW]

@return [ProvisioningStates] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed'

small_image[RW]

@return [String] Small Image associated with the Property or EntityType.

status[RW]

@return [Status] The data source status. Possible values include: 'None', 'Active', 'Deleted'

tenant_id[RW]

@return [String] The hub name.

timestamp_field_name[RW]

@return [String] The timestamp property name. Represents the time when the interaction or profile update happened.

type_name[RW]

@return [String] The name of the entity.

Public Class Methods

mapper() click to toggle source

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

# File lib/2017-01-01/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