EntityTypeDefinition Class

Package:

com.azure.resourcemanager.customerinsights.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-customerinsights:1.0.0-beta.2

• java.lang.Object
• • com.azure.resourcemanager.customerinsights.models.MetadataDefinitionBase
  • • com.azure.resourcemanager.customerinsights.models.EntityTypeDefinition

public class EntityTypeDefinition
extends MetadataDefinitionBase

Describes an entity.

Constructor Summary

Constructor	Description
EntityTypeDefinition()	Creates an instance of EntityTypeDefinition class.

Method Summary

Modifier and Type	Method and Description
String	apiEntitySetName() Get the apiEntitySetName property: The api entity set name.
EntityTypes	entityType() Get the entityType property: Type of entity.
List<PropertyDefinition>	fields() Get the fields property: The properties of the Profile.
Integer	instancesCount() Get the instancesCount property: The instance count.
OffsetDateTime	lastChangedUtc() Get the lastChangedUtc property: The last changed time for the type definition.
ProvisioningStates	provisioningState() Get the provisioningState property: Provisioning state.
String	schemaItemTypeLink() Get the schemaItemTypeLink property: The schema org link.
String	tenantId() Get the tenantId property: The hub name.
String	timestampFieldName() Get the timestampFieldName property: The timestamp property name.
String	typeName() Get the typeName property: The name of the entity.
void	validate() Validates the instance.
EntityTypeDefinition	withApiEntitySetName(String apiEntitySetName) Set the apiEntitySetName property: The api entity set name.
EntityTypeDefinition	withAttributes(Map<String,List<String>> attributes) Set the attributes property: The attributes for the Type.
EntityTypeDefinition	withDescription(Map<String,String> description) Set the description property: Localized descriptions for the property.
EntityTypeDefinition	withDisplayName(Map<String,String> displayName) Set the displayName property: Localized display names for the property.
EntityTypeDefinition	withEntityType(EntityTypes entityType) Set the entityType property: Type of entity.
EntityTypeDefinition	withFields(List<PropertyDefinition> fields) Set the fields property: The properties of the Profile.
EntityTypeDefinition	withInstancesCount(Integer instancesCount) Set the instancesCount property: The instance count.
EntityTypeDefinition	withLargeImage(String largeImage) Set the largeImage property: Large Image associated with the Property or EntityType.
EntityTypeDefinition	withLocalizedAttributes(Map<String,Map<String,String>> localizedAttributes) Set the localizedAttributes property: Any custom localized attributes for the Type.
EntityTypeDefinition	withMediumImage(String mediumImage) Set the mediumImage property: Medium Image associated with the Property or EntityType.
EntityTypeDefinition	withSchemaItemTypeLink(String schemaItemTypeLink) Set the schemaItemTypeLink property: The schema org link.
EntityTypeDefinition	withSmallImage(String smallImage) Set the smallImage property: Small Image associated with the Property or EntityType.
EntityTypeDefinition	withTimestampFieldName(String timestampFieldName) Set the timestampFieldName property: The timestamp property name.
EntityTypeDefinition	withTypeName(String typeName) Set the typeName property: The name of the entity.

Methods inherited from MetadataDefinitionBase

attributes description displayName largeImage localizedAttributes mediumImage smallImage validate withAttributes withDescription withDisplayName withLargeImage withLocalizedAttributes withMediumImage withSmallImage

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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.

entityType

public EntityTypes entityType()

Get the entityType property: Type of entity.

Returns:

the entityType value.

fields

public List fields()

Get the fields property: The properties of the Profile.

Returns:

the fields value.

instancesCount

public Integer instancesCount()

Get the instancesCount property: The instance count.

Returns:

the instancesCount value.

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.

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.

typeName

public String typeName()

Get the typeName property: The name of the entity.

Returns:

the typeName value.

validate

public void validate()

Validates the instance.

Overrides:

EntityTypeDefinition.validate()

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.

withAttributes

public EntityTypeDefinition withAttributes(Map<>> attributes)

Set the attributes property: The attributes for the Type.

Overrides:

EntityTypeDefinition.withAttributes(Map<String,List<String>> attributes)

Parameters:

attributes

withDescription

public EntityTypeDefinition withDescription(Map description)

Set the description property: Localized descriptions for the property.

Overrides:

EntityTypeDefinition.withDescription(Map<String,String> description)

Parameters:

description

withDisplayName

public EntityTypeDefinition withDisplayName(Map displayName)

Set the displayName property: Localized display names for the property.

Overrides:

EntityTypeDefinition.withDisplayName(Map<String,String> displayName)

Parameters:

displayName

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.

withFields

public EntityTypeDefinition withFields(List fields)

Set the fields property: The properties of the Profile.

Parameters:

fields - the fields value to set.

Returns:

the EntityTypeDefinition object itself.

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.

withLargeImage

public EntityTypeDefinition withLargeImage(String largeImage)

Set the largeImage property: Large Image associated with the Property or EntityType.

Overrides:

EntityTypeDefinition.withLargeImage(String largeImage)

Parameters:

largeImage

withLocalizedAttributes

public EntityTypeDefinition withLocalizedAttributes(Map<>> localizedAttributes)

Set the localizedAttributes property: Any custom localized attributes for the Type.

Overrides:

EntityTypeDefinition.withLocalizedAttributes(Map<String,Map<String,String>> localizedAttributes)

Parameters:

localizedAttributes

withMediumImage

public EntityTypeDefinition withMediumImage(String mediumImage)

Set the mediumImage property: Medium Image associated with the Property or EntityType.

Overrides:

EntityTypeDefinition.withMediumImage(String mediumImage)

Parameters:

mediumImage

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.

withSmallImage

public EntityTypeDefinition withSmallImage(String smallImage)

Set the smallImage property: Small Image associated with the Property or EntityType.

Overrides:

EntityTypeDefinition.withSmallImage(String smallImage)

Parameters:

smallImage

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.

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.