Package com.azure.resourcemanager.customerinsights.models

Interface ProfileResourceFormat

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

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

    • strongIds

      List<StrongId> strongIds()
      Gets the strongIds property: The strong IDs.
      Returns:
      the strongIds 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

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

    • update

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

    • refresh

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

    • refresh

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

    • getEnrichingKpisWithResponse

      com.azure.core.http.rest.Response<List<KpiDefinition>> getEnrichingKpisWithResponse(com.azure.core.util.Context context)
      Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the KPIs that enrich the profile Type identified by the supplied name 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.

    • getEnrichingKpis

      List<KpiDefinition> getEnrichingKpis()
      Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.
      Returns:
      the KPIs that enrich the profile Type identified by the supplied name.
      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.