InteractionResourceFormatInner Class

Package:

com.azure.resourcemanager.customerinsights.fluent.models

Maven Artifact:

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

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.customerinsights.fluent.models.InteractionResourceFormatInner

public final class InteractionResourceFormatInner
extends ProxyResource

The interaction resource format.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	apiEntitySetName() Get the apiEntitySetName property: The api entity set name.
Map<String,List<String>>	attributes() Get the attributes property: The attributes for the Type.
List<DataSourcePrecedence>	dataSourcePrecedenceRules() Get the dataSourcePrecedenceRules property: This is specific to interactions modeled as activities.
String	dataSourceReferenceId() Get the dataSourceReferenceId property: The data source reference id.
DataSourceType	dataSourceType() Get the dataSourceType property: The data source type.
Map<String,String>	description() Get the description property: Localized descriptions for the property.
Map<String,String>	displayName() Get the displayName property: Localized display names for the property.
EntityTypes	entityType() Get the entityType property: Type of entity.
List<PropertyDefinition>	fields() Get the fields property: The properties of the Profile.
static InteractionResourceFormatInner	fromJson(JsonReader jsonReader) Reads an instance of InteractionResourceFormatInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
Integer	idPropertiesId() Get the id property: The data source ID.
List<String>	idPropertyNames() Get the idPropertyNames property: The id property names.
Integer	instancesCount() Get the instancesCount property: The instance count.
Boolean	isActivity() Get the isActivity property: An interaction can be tagged as an activity only during create.
String	largeImage() Get the largeImage property: Large Image associated with the Property or EntityType.
OffsetDateTime	lastChangedUtc() Get the lastChangedUtc property: The last changed time for the type definition.
Map<String,Map<String,String>>	localizedAttributes() Get the localizedAttributes property: Any custom localized attributes for the Type.
String	mediumImage() Get the mediumImage property: Medium Image associated with the Property or EntityType.
String	name() Get the name property: The name of the resource.
String	namePropertiesName() Get the name property: The data source name.
List<Participant>	participantProfiles() Get the participantProfiles property: Profiles that participated in the interaction.
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.
ProvisioningStates	provisioningState() Get the provisioningState property: Provisioning state.
String	schemaItemTypeLink() Get the schemaItemTypeLink property: The schema org link.
String	smallImage() Get the smallImage property: Small Image associated with the Property or EntityType.
Status	status() Get the status property: The data source status.
String	tenantId() Get the tenantId property: The hub name.
String	timestampFieldName() Get the timestampFieldName property: The timestamp property name.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
String	typeName() Get the typeName property: The name of the entity.
void	validate() Validates the instance.
InteractionResourceFormatInner	withApiEntitySetName(String apiEntitySetName) Set the apiEntitySetName property: The api entity set name.
InteractionResourceFormatInner	withAttributes(Map<String,List<String>> attributes) Set the attributes property: The attributes for the Type.
InteractionResourceFormatInner	withDescription(Map<String,String> description) Set the description property: Localized descriptions for the property.
InteractionResourceFormatInner	withDisplayName(Map<String,String> displayName) Set the displayName property: Localized display names for the property.
InteractionResourceFormatInner	withEntityType(EntityTypes entityType) Set the entityType property: Type of entity.
InteractionResourceFormatInner	withFields(List<PropertyDefinition> fields) Set the fields property: The properties of the Profile.
InteractionResourceFormatInner	withIdPropertyNames(List<String> idPropertyNames) Set the idPropertyNames property: The id property names.
InteractionResourceFormatInner	withInstancesCount(Integer instancesCount) Set the instancesCount property: The instance count.
InteractionResourceFormatInner	withIsActivity(Boolean isActivity) Set the isActivity property: An interaction can be tagged as an activity only during create.
InteractionResourceFormatInner	withLargeImage(String largeImage) Set the largeImage property: Large Image associated with the Property or EntityType.
InteractionResourceFormatInner	withLocalizedAttributes(Map<String,Map<String,String>> localizedAttributes) Set the localizedAttributes property: Any custom localized attributes for the Type.
InteractionResourceFormatInner	withMediumImage(String mediumImage) Set the mediumImage property: Medium Image associated with the Property or EntityType.
InteractionResourceFormatInner	withParticipantProfiles(List<Participant> participantProfiles) Set the participantProfiles property: Profiles that participated in the interaction.
InteractionResourceFormatInner	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.
InteractionResourceFormatInner	withSchemaItemTypeLink(String schemaItemTypeLink) Set the schemaItemTypeLink property: The schema org link.
InteractionResourceFormatInner	withSmallImage(String smallImage) Set the smallImage property: Small Image associated with the Property or EntityType.
InteractionResourceFormatInner	withTimestampFieldName(String timestampFieldName) Set the timestampFieldName property: The timestamp property name.
InteractionResourceFormatInner	withTypeName(String typeName) Set the typeName property: The name of the entity.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

InteractionResourceFormatInner

public InteractionResourceFormatInner()

Creates an instance of InteractionResourceFormatInner 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.

attributes

public Map<String,List<String>> attributes()

Get the attributes property: The attributes for the Type.

Returns:

the attributes value.

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.

dataSourceReferenceId

public String dataSourceReferenceId()

Get the dataSourceReferenceId property: The data source reference id.

Returns:

the dataSourceReferenceId value.

dataSourceType

public DataSourceType dataSourceType()

Get the dataSourceType property: The data source type.

Returns:

the dataSourceType value.

description

public Map<String,String> description()

Get the description property: Localized descriptions for the property.

Returns:

the description value.

displayName

public Map<String,String> displayName()

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

Returns:

the displayName value.

entityType

public EntityTypes entityType()

Get the entityType property: Type of entity.

Returns:

the entityType value.

fields

public List<PropertyDefinition> fields()

Get the fields property: The properties of the Profile.

Returns:

the fields value.

fromJson

public static InteractionResourceFormatInner fromJson(JsonReader jsonReader)

Reads an instance of InteractionResourceFormatInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of InteractionResourceFormatInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

InteractionResourceFormatInner.id()

Returns:

the id value.

idPropertiesId

public Integer idPropertiesId()

Get the id property: The data source ID.

Returns:

the id value.

idPropertyNames

public List<String> idPropertyNames()

Get the idPropertyNames property: The id property names. Properties which uniquely identify an interaction instance.

Returns:

the idPropertyNames value.

instancesCount

public Integer instancesCount()

Get the instancesCount property: The instance count.

Returns:

the instancesCount 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.

largeImage

public String largeImage()

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

Returns:

the largeImage value.

lastChangedUtc

public OffsetDateTime lastChangedUtc()

Get the lastChangedUtc property: The last changed time for the type definition.

Returns:

the lastChangedUtc value.

localizedAttributes

public Map<String,Map<String,String>> localizedAttributes()

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

Returns:

the localizedAttributes value.

mediumImage

public String mediumImage()

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

Returns:

the mediumImage value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

InteractionResourceFormatInner.name()

Returns:

the name value.

namePropertiesName

public String namePropertiesName()

Get the name property: The data source name.

Returns:

the name value.

participantProfiles

public List<Participant> participantProfiles()

Get the participantProfiles property: Profiles that participated in the interaction.

Returns:

the participantProfiles value.

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.

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.

smallImage

public String smallImage()

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

Returns:

the smallImage value.

status

public Status status()

Get the status property: The data source status.

Returns:

the status 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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

InteractionResourceFormatInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

InteractionResourceFormatInner.type()

Returns:

the type 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.

withApiEntitySetName

public InteractionResourceFormatInner 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 InteractionResourceFormatInner object itself.

withAttributes

public InteractionResourceFormatInner withAttributes(Map<String,List<String>> attributes)

Set the attributes property: The attributes for the Type.

Parameters:

attributes - the attributes value to set.

Returns:

the InteractionResourceFormatInner object itself.

withDescription

public InteractionResourceFormatInner withDescription(Map<String,String> description)

Set the description property: Localized descriptions for the property.

Parameters:

description - the description value to set.

Returns:

the InteractionResourceFormatInner object itself.

withDisplayName

public InteractionResourceFormatInner withDisplayName(Map<String,String> displayName)

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

Parameters:

displayName - the displayName value to set.

Returns:

the InteractionResourceFormatInner object itself.

withEntityType

public InteractionResourceFormatInner withEntityType(EntityTypes entityType)

Set the entityType property: Type of entity.

Parameters:

entityType - the entityType value to set.

Returns:

the InteractionResourceFormatInner object itself.

withFields

public InteractionResourceFormatInner withFields(List<PropertyDefinition> fields)

Set the fields property: The properties of the Profile.

Parameters:

fields - the fields value to set.

Returns:

the InteractionResourceFormatInner object itself.

withIdPropertyNames

public InteractionResourceFormatInner 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 InteractionResourceFormatInner object itself.

withInstancesCount

public InteractionResourceFormatInner withInstancesCount(Integer instancesCount)

Set the instancesCount property: The instance count.

Parameters:

instancesCount - the instancesCount value to set.

Returns:

the InteractionResourceFormatInner object itself.

withIsActivity

public InteractionResourceFormatInner 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 InteractionResourceFormatInner object itself.

withLargeImage

public InteractionResourceFormatInner withLargeImage(String largeImage)

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

Parameters:

largeImage - the largeImage value to set.

Returns:

the InteractionResourceFormatInner object itself.

withLocalizedAttributes

public InteractionResourceFormatInner withLocalizedAttributes(Map<String,Map<String,String>> localizedAttributes)

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

Parameters:

localizedAttributes - the localizedAttributes value to set.

Returns:

the InteractionResourceFormatInner object itself.

withMediumImage

public InteractionResourceFormatInner withMediumImage(String mediumImage)

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

Parameters:

mediumImage - the mediumImage value to set.

Returns:

the InteractionResourceFormatInner object itself.

withParticipantProfiles

public InteractionResourceFormatInner withParticipantProfiles(List<Participant> participantProfiles)

Set the participantProfiles property: Profiles that participated in the interaction.

Parameters:

participantProfiles - the participantProfiles value to set.

Returns:

the InteractionResourceFormatInner object itself.

withPrimaryParticipantProfilePropertyName

public InteractionResourceFormatInner 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 InteractionResourceFormatInner object itself.

withSchemaItemTypeLink

public InteractionResourceFormatInner 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 InteractionResourceFormatInner object itself.

withSmallImage

public InteractionResourceFormatInner withSmallImage(String smallImage)

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

Parameters:

smallImage - the smallImage value to set.

Returns:

the InteractionResourceFormatInner object itself.

withTimestampFieldName

public InteractionResourceFormatInner 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 InteractionResourceFormatInner object itself.

withTypeName

public InteractionResourceFormatInner withTypeName(String typeName)

Set the typeName property: The name of the entity.

Parameters:

typeName - the typeName value to set.

Returns:

the InteractionResourceFormatInner object itself.