Package com.azure.resourcemanager.customerinsights.models

Class EntityTypeDefinition

java.lang.Object
com.azure.resourcemanager.customerinsights.models.MetadataDefinitionBase
com.azure.resourcemanager.customerinsights.models.EntityTypeDefinition
Direct Known Subclasses:
InteractionTypeDefinition, ProfileTypeDefinition
public class EntityTypeDefinition extends MetadataDefinitionBase
Describes an entity.

  • Constructor Details

    • EntityTypeDefinition

      public EntityTypeDefinition()
      Creates an instance of EntityTypeDefinition class.

  • Method Details

    • apiEntitySetName

      public String apiEntitySetName()
      Get the apiEntitySetName property: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
      Returns:
      the apiEntitySetName value.

    • withApiEntitySetName

      public EntityTypeDefinition 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.
      Parameters:
      apiEntitySetName - the apiEntitySetName value to set.
      Returns:
      the EntityTypeDefinition object itself.

    • entityType

      public EntityTypes entityType()
      Get the entityType property: Type of entity.
      Returns:
      the entityType value.

    • withEntityType

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

    • fields

      public List<PropertyDefinition> fields()
      Get the fields property: The properties of the Profile.
      Returns:
      the fields value.

    • withFields

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

    • instancesCount

      public Integer instancesCount()
      Get the instancesCount property: The instance count.
      Returns:
      the instancesCount value.

    • withInstancesCount

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

    • lastChangedUtc

      public OffsetDateTime lastChangedUtc()
      Get the lastChangedUtc property: The last changed time for the type definition.
      Returns:
      the lastChangedUtc value.

    • provisioningState

      public ProvisioningStates provisioningState()
      Get the provisioningState property: Provisioning state.
      Returns:
      the provisioningState value.

    • schemaItemTypeLink

      public String schemaItemTypeLink()
      Get the schemaItemTypeLink property: The schema org link. This helps ACI identify and suggest semantic models.
      Returns:
      the schemaItemTypeLink value.

    • withSchemaItemTypeLink

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

    • tenantId

      public String tenantId()
      Get the tenantId property: The hub name.
      Returns:
      the tenantId value.

    • timestampFieldName

      public String timestampFieldName()
      Get the timestampFieldName property: The timestamp property name. Represents the time when the interaction or profile update happened.
      Returns:
      the timestampFieldName value.

    • withTimestampFieldName

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

    • typeName

      public String typeName()
      Get the typeName property: The name of the entity.
      Returns:
      the typeName value.

    • withTypeName

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

    • withAttributes

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

    • withDescription

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

    • withDisplayName

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

    • withLocalizedAttributes

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

    • withSmallImage

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

    • withMediumImage

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

    • withLargeImage

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

    • validate

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