Package com.azure.resourcemanager.customerinsights.fluent.models

Class InteractionTypeDefinition

java.lang.Object
com.azure.resourcemanager.customerinsights.models.MetadataDefinitionBase
com.azure.resourcemanager.customerinsights.models.EntityTypeDefinition
com.azure.resourcemanager.customerinsights.fluent.models.InteractionTypeDefinition
public final class InteractionTypeDefinition extends EntityTypeDefinition
The Interaction Type Definition.

  • Constructor Details

    • InteractionTypeDefinition

      public InteractionTypeDefinition()
      Creates an instance of InteractionTypeDefinition class.

  • Method Details

    • idPropertyNames

      public List<String> idPropertyNames()
      Get the idPropertyNames property: The id property names. Properties which uniquely identify an interaction instance.
      Returns:
      the idPropertyNames value.

    • withIdPropertyNames

      public InteractionTypeDefinition withIdPropertyNames(List<String> idPropertyNames)
      Set the idPropertyNames property: The id property names. Properties which uniquely identify an interaction instance.
      Parameters:
      idPropertyNames - the idPropertyNames value to set.
      Returns:
      the InteractionTypeDefinition object itself.

    • participantProfiles

      public List<Participant> participantProfiles()
      Get the participantProfiles property: Profiles that participated in the interaction.
      Returns:
      the participantProfiles value.

    • withParticipantProfiles

      public InteractionTypeDefinition withParticipantProfiles(List<Participant> participantProfiles)
      Set the participantProfiles property: Profiles that participated in the interaction.
      Parameters:
      participantProfiles - the participantProfiles value to set.
      Returns:
      the InteractionTypeDefinition object itself.

    • primaryParticipantProfilePropertyName

      public String primaryParticipantProfilePropertyName()
      Get the primaryParticipantProfilePropertyName property: 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.
      Returns:
      the primaryParticipantProfilePropertyName value.

    • withPrimaryParticipantProfilePropertyName

      public InteractionTypeDefinition withPrimaryParticipantProfilePropertyName(String primaryParticipantProfilePropertyName)
      Set the primaryParticipantProfilePropertyName property: 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.
      Parameters:
      primaryParticipantProfilePropertyName - the primaryParticipantProfilePropertyName value to set.
      Returns:
      the InteractionTypeDefinition object itself.

    • dataSourcePrecedenceRules

      public List<DataSourcePrecedence> dataSourcePrecedenceRules()
      Get the dataSourcePrecedenceRules property: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
      Returns:
      the dataSourcePrecedenceRules value.

    • isActivity

      public Boolean isActivity()
      Get the isActivity property: 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.
      Returns:
      the isActivity value.

    • withIsActivity

      public InteractionTypeDefinition withIsActivity(Boolean isActivity)
      Set the isActivity property: 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.
      Parameters:
      isActivity - the isActivity value to set.
      Returns:
      the InteractionTypeDefinition object itself.

    • withApiEntitySetName

      public InteractionTypeDefinition withApiEntitySetName(String apiEntitySetName)
      Set the apiEntitySetName property: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
      Overrides:
      withApiEntitySetName in class EntityTypeDefinition
      Parameters:
      apiEntitySetName - the apiEntitySetName value to set.
      Returns:
      the EntityTypeDefinition object itself.

    • withEntityType

      public InteractionTypeDefinition withEntityType(EntityTypes entityType)
      Set the entityType property: Type of entity.
      Overrides:
      withEntityType in class EntityTypeDefinition
      Parameters:
      entityType - the entityType value to set.
      Returns:
      the EntityTypeDefinition object itself.

    • withFields

      public InteractionTypeDefinition withFields(List<PropertyDefinition> fields)
      Set the fields property: The properties of the Profile.
      Overrides:
      withFields in class EntityTypeDefinition
      Parameters:
      fields - the fields value to set.
      Returns:
      the EntityTypeDefinition object itself.

    • withInstancesCount

      public InteractionTypeDefinition withInstancesCount(Integer instancesCount)
      Set the instancesCount property: The instance count.
      Overrides:
      withInstancesCount in class EntityTypeDefinition
      Parameters:
      instancesCount - the instancesCount value to set.
      Returns:
      the EntityTypeDefinition object itself.

    • withSchemaItemTypeLink

      public InteractionTypeDefinition withSchemaItemTypeLink(String schemaItemTypeLink)
      Set the schemaItemTypeLink property: The schema org link. This helps ACI identify and suggest semantic models.
      Overrides:
      withSchemaItemTypeLink in class EntityTypeDefinition
      Parameters:
      schemaItemTypeLink - the schemaItemTypeLink value to set.
      Returns:
      the EntityTypeDefinition object itself.

    • withTimestampFieldName

      public InteractionTypeDefinition withTimestampFieldName(String timestampFieldName)
      Set the timestampFieldName property: The timestamp property name. Represents the time when the interaction or profile update happened.
      Overrides:
      withTimestampFieldName in class EntityTypeDefinition
      Parameters:
      timestampFieldName - the timestampFieldName value to set.
      Returns:
      the EntityTypeDefinition object itself.

    • withTypeName

      public InteractionTypeDefinition withTypeName(String typeName)
      Set the typeName property: The name of the entity.
      Overrides:
      withTypeName in class EntityTypeDefinition
      Parameters:
      typeName - the typeName value to set.
      Returns:
      the EntityTypeDefinition object itself.

    • withAttributes

      public InteractionTypeDefinition withAttributes(Map<String,List<String>> attributes)
      Set the attributes property: The attributes for the Type.
      Overrides:
      withAttributes in class EntityTypeDefinition
      Parameters:
      attributes - the attributes value to set.
      Returns:
      the MetadataDefinitionBase object itself.

    • withDescription

      public InteractionTypeDefinition withDescription(Map<String,String> description)
      Set the description property: Localized descriptions for the property.
      Overrides:
      withDescription in class EntityTypeDefinition
      Parameters:
      description - the description value to set.
      Returns:
      the MetadataDefinitionBase object itself.

    • withDisplayName

      public InteractionTypeDefinition withDisplayName(Map<String,String> displayName)
      Set the displayName property: Localized display names for the property.
      Overrides:
      withDisplayName in class EntityTypeDefinition
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the MetadataDefinitionBase object itself.

    • withLocalizedAttributes

      public InteractionTypeDefinition withLocalizedAttributes(Map<String,Map<String,String>> localizedAttributes)
      Set the localizedAttributes property: Any custom localized attributes for the Type.
      Overrides:
      withLocalizedAttributes in class EntityTypeDefinition
      Parameters:
      localizedAttributes - the localizedAttributes value to set.
      Returns:
      the MetadataDefinitionBase object itself.

    • withSmallImage

      public InteractionTypeDefinition withSmallImage(String smallImage)
      Set the smallImage property: Small Image associated with the Property or EntityType.
      Overrides:
      withSmallImage in class EntityTypeDefinition
      Parameters:
      smallImage - the smallImage value to set.
      Returns:
      the MetadataDefinitionBase object itself.

    • withMediumImage

      public InteractionTypeDefinition withMediumImage(String mediumImage)
      Set the mediumImage property: Medium Image associated with the Property or EntityType.
      Overrides:
      withMediumImage in class EntityTypeDefinition
      Parameters:
      mediumImage - the mediumImage value to set.
      Returns:
      the MetadataDefinitionBase object itself.

    • withLargeImage

      public InteractionTypeDefinition withLargeImage(String largeImage)
      Set the largeImage property: Large Image associated with the Property or EntityType.
      Overrides:
      withLargeImage in class EntityTypeDefinition
      Parameters:
      largeImage - the largeImage value to set.
      Returns:
      the MetadataDefinitionBase object itself.

    • name

      public String name()
      Get the name property: The data source name.
      Returns:
      the name value.

    • dataSourceType

      public DataSourceType dataSourceType()
      Get the dataSourceType property: The data source type.
      Returns:
      the dataSourceType value.

    • status

      public Status status()
      Get the status property: The data source status.
      Returns:
      the status value.

    • id

      public Integer id()
      Get the id property: The data source ID.
      Returns:
      the id value.

    • dataSourceReferenceId

      public String dataSourceReferenceId()
      Get the dataSourceReferenceId property: The data source reference id.
      Returns:
      the dataSourceReferenceId value.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class EntityTypeDefinition
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.