KpiResourceFormat Interface

Package:

com.azure.resourcemanager.customerinsights.models

Maven Artifact:

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

public interface KpiResourceFormat

An immutable client-side representation of KpiResourceFormat.

Method Summary

Modifier and Type	Method and Description
abstract List<KpiAlias>	aliases() Gets the aliases property: The aliases.
abstract CalculationWindowTypes	calculationWindow() Gets the calculationWindow property: The calculation window.
abstract String	calculationWindowFieldName() Gets the calculationWindowFieldName property: Name of calculation window field.
abstract Map<String,String>	description() Gets the description property: Localized description for the KPI.
abstract Map<String,String>	displayName() Gets the displayName property: Localized display name for the KPI.
abstract EntityTypes	entityType() Gets the entityType property: The mapping entity type.
abstract String	entityTypeName() Gets the entityTypeName property: The mapping entity name.
abstract String	expression() Gets the expression property: The computation expression for the KPI.
abstract List<KpiExtract>	extracts() Gets the extracts property: The KPI extracts.
abstract String	filter() Gets the filter property: The filter expression for the KPI.
abstract KpiFunctions	function() Gets the function property: The computation function for the KPI.
abstract List<String>	groupBy() Gets the groupBy property: the group by properties for the KPI.
abstract List<KpiGroupByMetadata>	groupByMetadata() Gets the groupByMetadata property: The KPI GroupByMetadata.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract KpiResourceFormatInner	innerModel() Gets the inner com.azure.resourcemanager.customerinsights.fluent.models.KpiResourceFormatInner object.
abstract String	kpiName() Gets the kpiName property: The KPI name.
abstract String	name() Gets the name property: The name of the resource.
abstract List<KpiParticipantProfilesMetadata>	participantProfilesMetadata() Gets the participantProfilesMetadata property: The participant profiles.
abstract ProvisioningStates	provisioningState() Gets the provisioningState property: Provisioning state.
abstract KpiResourceFormat	refresh() Refreshes the resource to sync with Azure.
abstract KpiResourceFormat	refresh(Context context) Refreshes the resource to sync with Azure.
abstract void	reprocess() Reprocesses the Kpi values of the specified KPI.
abstract Response<Void>	reprocessWithResponse(Context context) Reprocesses the Kpi values of the specified KPI.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract String	tenantId() Gets the tenantId property: The hub name.
abstract KpiThresholds	thresHolds() Gets the thresHolds property: The KPI thresholds.
abstract String	type() Gets the type property: The type of the resource.
abstract String	unit() Gets the unit property: The unit of measurement for the KPI.
abstract Update	update() Begins update for the KpiResourceFormat resource.

Method Details

aliases

public abstract List aliases()

Gets the aliases property: The aliases.

Returns:

the aliases value.

calculationWindow

public abstract CalculationWindowTypes calculationWindow()

Gets the calculationWindow property: The calculation window.

Returns:

the calculationWindow value.

calculationWindowFieldName

public abstract String calculationWindowFieldName()

Gets the calculationWindowFieldName property: Name of calculation window field.

Returns:

the calculationWindowFieldName value.

description

public abstract Map description()

Gets the description property: Localized description for the KPI.

Returns:

the description value.

displayName

public abstract Map displayName()

Gets the displayName property: Localized display name for the KPI.

Returns:

the displayName value.

entityType

public abstract EntityTypes entityType()

Gets the entityType property: The mapping entity type.

Returns:

the entityType value.

entityTypeName

public abstract String entityTypeName()

Gets the entityTypeName property: The mapping entity name.

Returns:

the entityTypeName value.

expression

public abstract String expression()

Gets the expression property: The computation expression for the KPI.

Returns:

the expression value.

extracts

public abstract List extracts()

Gets the extracts property: The KPI extracts.

Returns:

the extracts value.

filter

public abstract String filter()

Gets the filter property: The filter expression for the KPI.

Returns:

the filter value.

function

public abstract KpiFunctions function()

Gets the function property: The computation function for the KPI.

Returns:

the function value.

groupBy

public abstract List groupBy()

Gets the groupBy property: the group by properties for the KPI.

Returns:

the groupBy value.

groupByMetadata

public abstract List groupByMetadata()

Gets the groupByMetadata property: The KPI GroupByMetadata.

Returns:

the groupByMetadata value.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract KpiResourceFormatInner innerModel()

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

Returns:

the inner object.

kpiName

public abstract String kpiName()

Gets the kpiName property: The KPI name.

Returns:

the kpiName value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

participantProfilesMetadata

public abstract List participantProfilesMetadata()

Gets the participantProfilesMetadata property: The participant profiles.

Returns:

the participantProfilesMetadata value.

provisioningState

public abstract ProvisioningStates provisioningState()

Gets the provisioningState property: Provisioning state.

Returns:

the provisioningState value.

refresh

public abstract KpiResourceFormat refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract KpiResourceFormat refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

reprocess

public abstract void reprocess()

Reprocesses the Kpi values of the specified KPI.

reprocessWithResponse

public abstract Response reprocessWithResponse(Context context)

Reprocesses the Kpi values of the specified KPI.

Parameters:

context - The context to associate with this operation.

Returns:

the Response<T>.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

tenantId

public abstract String tenantId()

Gets the tenantId property: The hub name.

Returns:

the tenantId value.

thresHolds

public abstract KpiThresholds thresHolds()

Gets the thresHolds property: The KPI thresholds.

Returns:

the thresHolds value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

unit

public abstract String unit()

Gets the unit property: The unit of measurement for the KPI.

Returns:

the unit value.

update

public abstract KpiResourceFormat.Update update()

Begins update for the KpiResourceFormat resource.

Returns:

the stage of resource update.