Package com.azure.resourcemanager.customerinsights.models

Interface InteractionResourceFormat

public interface InteractionResourceFormat
An immutable client-side representation of InteractionResourceFormat.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • idPropertyNames

      List<String> idPropertyNames()
      Gets the idPropertyNames property: The id property names. Properties which uniquely identify an interaction instance.
      Returns:
      the idPropertyNames value.

    • participantProfiles

      List<Participant> participantProfiles()
      Gets the participantProfiles property: Profiles that participated in the interaction.
      Returns:
      the participantProfiles value.

    • primaryParticipantProfilePropertyName

      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.

    • dataSourcePrecedenceRules

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

    • isActivity

      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.

    • namePropertiesName

      String namePropertiesName()
      Gets the namePropertiesName property: The data source name.
      Returns:
      the namePropertiesName value.

    • dataSourceType

      DataSourceType dataSourceType()
      Gets the dataSourceType property: The data source type.
      Returns:
      the dataSourceType value.

    • status

      Status status()
      Gets the status property: The data source status.
      Returns:
      the status value.

    • idPropertiesId

      Integer idPropertiesId()
      Gets the idPropertiesId property: The data source ID.
      Returns:
      the idPropertiesId value.

    • dataSourceReferenceId

      String dataSourceReferenceId()
      Gets the dataSourceReferenceId property: The data source reference id.
      Returns:
      the dataSourceReferenceId value.

    • apiEntitySetName

      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.

    • entityType

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

    • fields

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

    • instancesCount

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

    • lastChangedUtc

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

    • provisioningState

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

    • schemaItemTypeLink

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

    • tenantId

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

    • timestampFieldName

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

    • typeName

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

    • attributes

      Map<String,List<String>> attributes()
      Gets the attributes property: The attributes for the Type.
      Returns:
      the attributes value.

    • description

      Map<String,String> description()
      Gets the description property: Localized descriptions for the property.
      Returns:
      the description value.

    • displayName

      Map<String,String> displayName()
      Gets the displayName property: Localized display names for the property.
      Returns:
      the displayName value.

    • localizedAttributes

      Map<String,Map<String,String>> localizedAttributes()
      Gets the localizedAttributes property: Any custom localized attributes for the Type.
      Returns:
      the localizedAttributes value.

    • smallImage

      String smallImage()
      Gets the smallImage property: Small Image associated with the Property or EntityType.
      Returns:
      the smallImage value.

    • mediumImage

      String mediumImage()
      Gets the mediumImage property: Medium Image associated with the Property or EntityType.
      Returns:
      the mediumImage value.

    • largeImage

      String largeImage()
      Gets the largeImage property: Large Image associated with the Property or EntityType.
      Returns:
      the largeImage value.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      InteractionResourceFormatInner innerModel()
      Gets the inner com.azure.resourcemanager.customerinsights.fluent.models.InteractionResourceFormatInner object.
      Returns:
      the inner object.

    • update

      InteractionResourceFormat.Update update()
      Begins update for the InteractionResourceFormat resource.
      Returns:
      the stage of resource update.

    • refresh

      InteractionResourceFormat refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      InteractionResourceFormat refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • suggestRelationshipLinksWithResponse

      com.azure.core.http.rest.Response<SuggestRelationshipLinksResponse> suggestRelationshipLinksWithResponse(com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • suggestRelationshipLinks

      SuggestRelationshipLinksResponse suggestRelationshipLinks()
      Suggests relationships to create relationship links.
      Returns:
      the response of suggest relationship links operation.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.