InteractionResourceFormat Interface

Package:

com.azure.resourcemanager.customerinsights.models

Maven Artifact:

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

public interface InteractionResourceFormat

An immutable client-side representation of InteractionResourceFormat.

Method Summary

Modifier and Type	Method and Description
abstract String	apiEntitySetName() Gets the apiEntitySetName property: The api entity set name.
abstract Map<String,List<String>>	attributes() Gets the attributes property: The attributes for the Type.
abstract List<DataSourcePrecedence>	dataSourcePrecedenceRules() Gets the dataSourcePrecedenceRules property: This is specific to interactions modeled as activities.
abstract String	dataSourceReferenceId() Gets the dataSourceReferenceId property: The data source reference id.
abstract DataSourceType	dataSourceType() Gets the dataSourceType property: The data source type.
abstract Map<String,String>	description() Gets the description property: Localized descriptions for the property.
abstract Map<String,String>	displayName() Gets the displayName property: Localized display names for the property.
abstract EntityTypes	entityType() Gets the entityType property: Type of entity.
abstract List<PropertyDefinition>	fields() Gets the fields property: The properties of the Profile.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract Integer	idPropertiesId() Gets the idPropertiesId property: The data source ID.
abstract List<String>	idPropertyNames() Gets the idPropertyNames property: The id property names.
abstract InteractionResourceFormatInner	innerModel() Gets the inner com.azure.resourcemanager.customerinsights.fluent.models.InteractionResourceFormatInner object.
abstract Integer	instancesCount() Gets the instancesCount property: The instance count.
abstract Boolean	isActivity() Gets the isActivity property: An interaction can be tagged as an activity only during create.
abstract String	largeImage() Gets the largeImage property: Large Image associated with the Property or EntityType.
abstract OffsetDateTime	lastChangedUtc() Gets the lastChangedUtc property: The last changed time for the type definition.
abstract Map<String,Map<String,String>>	localizedAttributes() Gets the localizedAttributes property: Any custom localized attributes for the Type.
abstract String	mediumImage() Gets the mediumImage property: Medium Image associated with the Property or EntityType.
abstract String	name() Gets the name property: The name of the resource.
abstract String	namePropertiesName() Gets the namePropertiesName property: The data source name.
abstract List<Participant>	participantProfiles() Gets the participantProfiles property: Profiles that participated in the interaction.
abstract String	primaryParticipantProfilePropertyName() Gets 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.
abstract ProvisioningStates	provisioningState() Gets the provisioningState property: Provisioning state.
abstract InteractionResourceFormat	refresh() Refreshes the resource to sync with Azure.
abstract InteractionResourceFormat	refresh(Context context) Refreshes the resource to sync with Azure.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract String	schemaItemTypeLink() Gets the schemaItemTypeLink property: The schema org link.
abstract String	smallImage() Gets the smallImage property: Small Image associated with the Property or EntityType.
abstract Status	status() Gets the status property: The data source status.
abstract SuggestRelationshipLinksResponse	suggestRelationshipLinks() Suggests relationships to create relationship links.
abstract Response<SuggestRelationshipLinksResponse>	suggestRelationshipLinksWithResponse(Context context) Suggests relationships to create relationship links.
abstract String	tenantId() Gets the tenantId property: The hub name.
abstract String	timestampFieldName() Gets the timestampFieldName property: The timestamp property name.
abstract String	type() Gets the type property: The type of the resource.
abstract String	typeName() Gets the typeName property: The name of the entity.
abstract Update	update() Begins update for the InteractionResourceFormat resource.

Method Details

apiEntitySetName

public abstract String apiEntitySetName()

Gets 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 abstract Map<>> attributes()

Gets the attributes property: The attributes for the Type.

Returns:

the attributes value.

dataSourcePrecedenceRules

public abstract List dataSourcePrecedenceRules()

Gets 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 abstract String dataSourceReferenceId()

Gets the dataSourceReferenceId property: The data source reference id.

Returns:

the dataSourceReferenceId value.

dataSourceType

public abstract DataSourceType dataSourceType()

Gets the dataSourceType property: The data source type.

Returns:

the dataSourceType value.

description

public abstract Map description()

Gets the description property: Localized descriptions for the property.

Returns:

the description value.

displayName

public abstract Map displayName()

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

Returns:

the displayName value.

entityType

public abstract EntityTypes entityType()

Gets the entityType property: Type of entity.

Returns:

the entityType value.

fields

public abstract List fields()

Gets the fields property: The properties of the Profile.

Returns:

the fields value.

id

public abstract String id()

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

Returns:

the id value.

idPropertiesId

public abstract Integer idPropertiesId()

Gets the idPropertiesId property: The data source ID.

Returns:

the idPropertiesId value.

idPropertyNames

public abstract List idPropertyNames()

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

Returns:

the idPropertyNames value.

innerModel

public abstract InteractionResourceFormatInner innerModel()

Gets the inner com.azure.resourcemanager.customerinsights.fluent.models.InteractionResourceFormatInner object.

Returns:

the inner object.

instancesCount

public abstract Integer instancesCount()

Gets the instancesCount property: The instance count.

Returns:

the instancesCount value.

isActivity

public abstract Boolean isActivity()

Gets 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 abstract String largeImage()

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

Returns:

the largeImage value.

lastChangedUtc

public abstract OffsetDateTime lastChangedUtc()

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

Returns:

the lastChangedUtc value.

localizedAttributes

public abstract Map<>> localizedAttributes()

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

Returns:

the localizedAttributes value.

mediumImage

public abstract String mediumImage()

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

Returns:

the mediumImage value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

namePropertiesName

public abstract String namePropertiesName()

Gets the namePropertiesName property: The data source name.

Returns:

the namePropertiesName value.

participantProfiles

public abstract List participantProfiles()

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

Returns:

the participantProfiles value.

primaryParticipantProfilePropertyName

public abstract String primaryParticipantProfilePropertyName()

Gets 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 abstract ProvisioningStates provisioningState()

Gets the provisioningState property: Provisioning state.

Returns:

the provisioningState value.

refresh

public abstract InteractionResourceFormat refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract InteractionResourceFormat refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

schemaItemTypeLink

public abstract String schemaItemTypeLink()

Gets the schemaItemTypeLink property: The schema org link. This helps ACI identify and suggest semantic models.

Returns:

the schemaItemTypeLink value.

smallImage

public abstract String smallImage()

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

Returns:

the smallImage value.

status

public abstract Status status()

Gets the status property: The data source status.

Returns:

the status value.

suggestRelationshipLinks

public abstract SuggestRelationshipLinksResponse suggestRelationshipLinks()

Suggests relationships to create relationship links.

Returns:

the response of suggest relationship links operation.

suggestRelationshipLinksWithResponse

public abstract Response suggestRelationshipLinksWithResponse(Context context)

Suggests relationships to create relationship links.

Parameters:

context - The context to associate with this operation.

Returns:

the response of suggest relationship links operation along with Response<T>.

tenantId

public abstract String tenantId()

Gets the tenantId property: The hub name.

Returns:

the tenantId value.

timestampFieldName

public abstract String timestampFieldName()

Gets the timestampFieldName property: The timestamp property name. Represents the time when the interaction or profile update happened.

Returns:

the timestampFieldName value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

typeName

public abstract String typeName()

Gets the typeName property: The name of the entity.

Returns:

the typeName value.

update

public abstract InteractionResourceFormat.Update update()

Begins update for the InteractionResourceFormat resource.

Returns:

the stage of resource update.