ProfileResourceFormat Interface

public interface ProfileResourceFormat

An immutable client-side representation of ProfileResourceFormat.

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 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 List<KpiDefinition> getEnrichingKpis()

Gets the KPIs that enrich the profile Type identified by the supplied name.

abstract Response<List<KpiDefinition>> getEnrichingKpisWithResponse(Context context)

Gets the KPIs that enrich the profile Type identified by the supplied name.

abstract String id()

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

abstract ProfileResourceFormatInner innerModel()

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

abstract Integer instancesCount()

Gets the instancesCount property: The instance count.

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

Gets the provisioningState property: Provisioning state.

abstract ProfileResourceFormat refresh()

Refreshes the resource to sync with Azure.

abstract ProfileResourceFormat 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 List<StrongId> strongIds()

Gets the strongIds property: The strong IDs.

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

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.

getEnrichingKpis

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

getEnrichingKpisWithResponse

public abstract Response<>> getEnrichingKpisWithResponse(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<T>.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract ProfileResourceFormatInner innerModel()

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

Returns:

the inner object.

instancesCount

public abstract Integer instancesCount()

Gets the instancesCount property: The instance count.

Returns:

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

provisioningState

public abstract ProvisioningStates provisioningState()

Gets the provisioningState property: Provisioning state.

Returns:

the provisioningState value.

refresh

public abstract ProfileResourceFormat refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

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

strongIds

public abstract List strongIds()

Gets the strongIds property: The strong IDs.

Returns:

the strongIds value.

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 ProfileResourceFormat.Update update()

Begins update for the ProfileResourceFormat resource.

Returns:

the stage of resource update.

Applies to