PropertyDefinition 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.PropertyDefinition

public final class PropertyDefinition

Property definition.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	arrayValueSeparator() Get the arrayValueSeparator property: Array value separator for properties with isArray set.
List<DataSourcePrecedence>	dataSourcePrecedenceRules() Get the dataSourcePrecedenceRules property: This is specific to interactions modeled as activities.
List<ProfileEnumValidValuesFormat>	enumValidValues() Get the enumValidValues property: Describes valid values for an enum property.
String	fieldName() Get the fieldName property: Name of the property.
String	fieldType() Get the fieldType property: Type of the property.
Boolean	isArray() Get the isArray property: Indicates if the property is actually an array of the fieldType above on the data api.
Boolean	isAvailableInGraph() Get the isAvailableInGraph property: Whether property is available in graph or not.
Boolean	isEnum() Get the isEnum property: Indicates if the property is an enum.
Boolean	isFlagEnum() Get the isFlagEnum property: Indicates if the property is an flag enum.
Boolean	isImage() Get the isImage property: Whether the property is an Image.
Boolean	isLocalizedString() Get the isLocalizedString property: Whether the property is a localized string.
Boolean	isName() Get the isName property: Whether the property is a name or a part of name.
Boolean	isRequired() Get the isRequired property: Whether property value is required on instances, IsRequired field only for Interaction.
Integer	maxLength() Get the maxLength property: Max length of string.
String	propertyId() Get the propertyId property: The ID associated with the property.
String	schemaItemPropLink() Get the schemaItemPropLink property: URL encoded schema.org item prop link for the property.
void	validate() Validates the instance.
PropertyDefinition	withArrayValueSeparator(String arrayValueSeparator) Set the arrayValueSeparator property: Array value separator for properties with isArray set.
PropertyDefinition	withEnumValidValues(List<ProfileEnumValidValuesFormat> enumValidValues) Set the enumValidValues property: Describes valid values for an enum property.
PropertyDefinition	withFieldName(String fieldName) Set the fieldName property: Name of the property.
PropertyDefinition	withFieldType(String fieldType) Set the fieldType property: Type of the property.
PropertyDefinition	withIsArray(Boolean isArray) Set the isArray property: Indicates if the property is actually an array of the fieldType above on the data api.
PropertyDefinition	withIsAvailableInGraph(Boolean isAvailableInGraph) Set the isAvailableInGraph property: Whether property is available in graph or not.
PropertyDefinition	withIsEnum(Boolean isEnum) Set the isEnum property: Indicates if the property is an enum.
PropertyDefinition	withIsFlagEnum(Boolean isFlagEnum) Set the isFlagEnum property: Indicates if the property is an flag enum.
PropertyDefinition	withIsImage(Boolean isImage) Set the isImage property: Whether the property is an Image.
PropertyDefinition	withIsLocalizedString(Boolean isLocalizedString) Set the isLocalizedString property: Whether the property is a localized string.
PropertyDefinition	withIsName(Boolean isName) Set the isName property: Whether the property is a name or a part of name.
PropertyDefinition	withIsRequired(Boolean isRequired) Set the isRequired property: Whether property value is required on instances, IsRequired field only for Interaction.
PropertyDefinition	withMaxLength(Integer maxLength) Set the maxLength property: Max length of string.
PropertyDefinition	withPropertyId(String propertyId) Set the propertyId property: The ID associated with the property.
PropertyDefinition	withSchemaItemPropLink(String schemaItemPropLink) Set the schemaItemPropLink property: URL encoded schema.org item prop link for the property.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PropertyDefinition

public PropertyDefinition()

Creates an instance of PropertyDefinition class.

Method Details

arrayValueSeparator

public String arrayValueSeparator()

Get the arrayValueSeparator property: Array value separator for properties with isArray set.

Returns:

the arrayValueSeparator value.

dataSourcePrecedenceRules

public List 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.

enumValidValues

public List enumValidValues()

Get the enumValidValues property: Describes valid values for an enum property.

Returns:

the enumValidValues value.

fieldName

public String fieldName()

Get the fieldName property: Name of the property.

Returns:

the fieldName value.

fieldType

public String fieldType()

Get the fieldType property: Type of the property.

Returns:

the fieldType value.

isArray

public Boolean isArray()

Get the isArray property: Indicates if the property is actually an array of the fieldType above on the data api.

Returns:

the isArray value.

isAvailableInGraph

public Boolean isAvailableInGraph()

Get the isAvailableInGraph property: Whether property is available in graph or not.

Returns:

the isAvailableInGraph value.

isEnum

public Boolean isEnum()

Get the isEnum property: Indicates if the property is an enum.

Returns:

the isEnum value.

isFlagEnum

public Boolean isFlagEnum()

Get the isFlagEnum property: Indicates if the property is an flag enum.

Returns:

the isFlagEnum value.

isImage

public Boolean isImage()

Get the isImage property: Whether the property is an Image.

Returns:

the isImage value.

isLocalizedString

public Boolean isLocalizedString()

Get the isLocalizedString property: Whether the property is a localized string.

Returns:

the isLocalizedString value.

isName

public Boolean isName()

Get the isName property: Whether the property is a name or a part of name.

Returns:

the isName value.

isRequired

public Boolean isRequired()

Get the isRequired property: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

Returns:

the isRequired value.

maxLength

public Integer maxLength()

Get the maxLength property: Max length of string. Used only if type is string.

Returns:

the maxLength value.

propertyId

public String propertyId()

Get the propertyId property: The ID associated with the property.

Returns:

the propertyId value.

schemaItemPropLink

public String schemaItemPropLink()

Get the schemaItemPropLink property: URL encoded schema.org item prop link for the property.

Returns:

the schemaItemPropLink value.

validate

public void validate()

Validates the instance.

withArrayValueSeparator

public PropertyDefinition withArrayValueSeparator(String arrayValueSeparator)

Set the arrayValueSeparator property: Array value separator for properties with isArray set.

Parameters:

arrayValueSeparator - the arrayValueSeparator value to set.

Returns:

the PropertyDefinition object itself.

withEnumValidValues

public PropertyDefinition withEnumValidValues(List enumValidValues)

Set the enumValidValues property: Describes valid values for an enum property.

Parameters:

enumValidValues - the enumValidValues value to set.

Returns:

the PropertyDefinition object itself.

withFieldName

public PropertyDefinition withFieldName(String fieldName)

Set the fieldName property: Name of the property.

Parameters:

fieldName - the fieldName value to set.

Returns:

the PropertyDefinition object itself.

withFieldType

public PropertyDefinition withFieldType(String fieldType)

Set the fieldType property: Type of the property.

Parameters:

fieldType - the fieldType value to set.

Returns:

the PropertyDefinition object itself.

withIsArray

public PropertyDefinition withIsArray(Boolean isArray)

Set the isArray property: Indicates if the property is actually an array of the fieldType above on the data api.

Parameters:

isArray - the isArray value to set.

Returns:

the PropertyDefinition object itself.

withIsAvailableInGraph

public PropertyDefinition withIsAvailableInGraph(Boolean isAvailableInGraph)

Set the isAvailableInGraph property: Whether property is available in graph or not.

Parameters:

isAvailableInGraph - the isAvailableInGraph value to set.

Returns:

the PropertyDefinition object itself.

withIsEnum

public PropertyDefinition withIsEnum(Boolean isEnum)

Set the isEnum property: Indicates if the property is an enum.

Parameters:

isEnum - the isEnum value to set.

Returns:

the PropertyDefinition object itself.

withIsFlagEnum

public PropertyDefinition withIsFlagEnum(Boolean isFlagEnum)

Set the isFlagEnum property: Indicates if the property is an flag enum.

Parameters:

isFlagEnum - the isFlagEnum value to set.

Returns:

the PropertyDefinition object itself.

withIsImage

public PropertyDefinition withIsImage(Boolean isImage)

Set the isImage property: Whether the property is an Image.

Parameters:

isImage - the isImage value to set.

Returns:

the PropertyDefinition object itself.

withIsLocalizedString

public PropertyDefinition withIsLocalizedString(Boolean isLocalizedString)

Set the isLocalizedString property: Whether the property is a localized string.

Parameters:

isLocalizedString - the isLocalizedString value to set.

Returns:

the PropertyDefinition object itself.

withIsName

public PropertyDefinition withIsName(Boolean isName)

Set the isName property: Whether the property is a name or a part of name.

Parameters:

isName - the isName value to set.

Returns:

the PropertyDefinition object itself.

withIsRequired

public PropertyDefinition withIsRequired(Boolean isRequired)

Set the isRequired property: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

Parameters:

isRequired - the isRequired value to set.

Returns:

the PropertyDefinition object itself.

withMaxLength

public PropertyDefinition withMaxLength(Integer maxLength)

Set the maxLength property: Max length of string. Used only if type is string.

Parameters:

maxLength - the maxLength value to set.

Returns:

the PropertyDefinition object itself.

withPropertyId

public PropertyDefinition withPropertyId(String propertyId)

Set the propertyId property: The ID associated with the property.

Parameters:

propertyId - the propertyId value to set.

Returns:

the PropertyDefinition object itself.

withSchemaItemPropLink

public PropertyDefinition withSchemaItemPropLink(String schemaItemPropLink)

Set the schemaItemPropLink property: URL encoded schema.org item prop link for the property.

Parameters:

schemaItemPropLink - the schemaItemPropLink value to set.

Returns:

the PropertyDefinition object itself.