KpiDefinitionInner Class

  • java.lang.Object
    • com.azure.resourcemanager.customerinsights.fluent.models.KpiDefinitionInner

public class KpiDefinitionInner

Defines the KPI Threshold limits.

Constructor Summary

Constructor Description
KpiDefinitionInner()

Creates an instance of KpiDefinitionInner class.

Method Summary

Modifier and Type Method and Description
List<KpiAlias> aliases()

Get the aliases property: The aliases.

CalculationWindowTypes calculationWindow()

Get the calculationWindow property: The calculation window.

String calculationWindowFieldName()

Get the calculationWindowFieldName property: Name of calculation window field.

Map<String,String> description()

Get the description property: Localized description for the KPI.

Map<String,String> displayName()

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

EntityTypes entityType()

Get the entityType property: The mapping entity type.

String entityTypeName()

Get the entityTypeName property: The mapping entity name.

String expression()

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

List<KpiExtract> extracts()

Get the extracts property: The KPI extracts.

String filter()

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

KpiFunctions function()

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

List<String> groupBy()

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

List<KpiGroupByMetadata> groupByMetadata()

Get the groupByMetadata property: The KPI GroupByMetadata.

String kpiName()

Get the kpiName property: The KPI name.

List<KpiParticipantProfilesMetadata> participantProfilesMetadata()

Get the participantProfilesMetadata property: The participant profiles.

ProvisioningStates provisioningState()

Get the provisioningState property: Provisioning state.

String tenantId()

Get the tenantId property: The hub name.

KpiThresholds thresHolds()

Get the thresHolds property: The KPI thresholds.

String unit()

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

void validate()

Validates the instance.

KpiDefinitionInner withAliases(List<KpiAlias> aliases)

Set the aliases property: The aliases.

KpiDefinitionInner withCalculationWindow(CalculationWindowTypes calculationWindow)

Set the calculationWindow property: The calculation window.

KpiDefinitionInner withCalculationWindowFieldName(String calculationWindowFieldName)

Set the calculationWindowFieldName property: Name of calculation window field.

KpiDefinitionInner withDescription(Map<String,String> description)

Set the description property: Localized description for the KPI.

KpiDefinitionInner withDisplayName(Map<String,String> displayName)

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

KpiDefinitionInner withEntityType(EntityTypes entityType)

Set the entityType property: The mapping entity type.

KpiDefinitionInner withEntityTypeName(String entityTypeName)

Set the entityTypeName property: The mapping entity name.

KpiDefinitionInner withExpression(String expression)

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

KpiDefinitionInner withExtracts(List<KpiExtract> extracts)

Set the extracts property: The KPI extracts.

KpiDefinitionInner withFilter(String filter)

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

KpiDefinitionInner withFunction(KpiFunctions function)

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

KpiDefinitionInner withGroupBy(List<String> groupBy)

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

KpiDefinitionInner withThresHolds(KpiThresholds thresHolds)

Set the thresHolds property: The KPI thresholds.

KpiDefinitionInner withUnit(String unit)

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

Methods inherited from java.lang.Object

Constructor Details

KpiDefinitionInner

public KpiDefinitionInner()

Creates an instance of KpiDefinitionInner class.

Method Details

aliases

public List aliases()

Get the aliases property: The aliases.

Returns:

the aliases value.

calculationWindow

public CalculationWindowTypes calculationWindow()

Get the calculationWindow property: The calculation window.

Returns:

the calculationWindow value.

calculationWindowFieldName

public String calculationWindowFieldName()

Get the calculationWindowFieldName property: Name of calculation window field.

Returns:

the calculationWindowFieldName value.

description

public Map description()

Get the description property: Localized description for the KPI.

Returns:

the description value.

displayName

public Map displayName()

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

Returns:

the displayName value.

entityType

public EntityTypes entityType()

Get the entityType property: The mapping entity type.

Returns:

the entityType value.

entityTypeName

public String entityTypeName()

Get the entityTypeName property: The mapping entity name.

Returns:

the entityTypeName value.

expression

public String expression()

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

Returns:

the expression value.

extracts

public List extracts()

Get the extracts property: The KPI extracts.

Returns:

the extracts value.

filter

public String filter()

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

Returns:

the filter value.

function

public KpiFunctions function()

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

Returns:

the function value.

groupBy

public List groupBy()

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

Returns:

the groupBy value.

groupByMetadata

public List groupByMetadata()

Get the groupByMetadata property: The KPI GroupByMetadata.

Returns:

the groupByMetadata value.

kpiName

public String kpiName()

Get the kpiName property: The KPI name.

Returns:

the kpiName value.

participantProfilesMetadata

public List participantProfilesMetadata()

Get the participantProfilesMetadata property: The participant profiles.

Returns:

the participantProfilesMetadata value.

provisioningState

public ProvisioningStates provisioningState()

Get the provisioningState property: Provisioning state.

Returns:

the provisioningState value.

tenantId

public String tenantId()

Get the tenantId property: The hub name.

Returns:

the tenantId value.

thresHolds

public KpiThresholds thresHolds()

Get the thresHolds property: The KPI thresholds.

Returns:

the thresHolds value.

unit

public String unit()

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

Returns:

the unit value.

validate

public void validate()

Validates the instance.

withAliases

public KpiDefinitionInner withAliases(List aliases)

Set the aliases property: The aliases.

Parameters:

aliases - the aliases value to set.

Returns:

the KpiDefinitionInner object itself.

withCalculationWindow

public KpiDefinitionInner withCalculationWindow(CalculationWindowTypes calculationWindow)

Set the calculationWindow property: The calculation window.

Parameters:

calculationWindow - the calculationWindow value to set.

Returns:

the KpiDefinitionInner object itself.

withCalculationWindowFieldName

public KpiDefinitionInner withCalculationWindowFieldName(String calculationWindowFieldName)

Set the calculationWindowFieldName property: Name of calculation window field.

Parameters:

calculationWindowFieldName - the calculationWindowFieldName value to set.

Returns:

the KpiDefinitionInner object itself.

withDescription

public KpiDefinitionInner withDescription(Map description)

Set the description property: Localized description for the KPI.

Parameters:

description - the description value to set.

Returns:

the KpiDefinitionInner object itself.

withDisplayName

public KpiDefinitionInner withDisplayName(Map displayName)

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

Parameters:

displayName - the displayName value to set.

Returns:

the KpiDefinitionInner object itself.

withEntityType

public KpiDefinitionInner withEntityType(EntityTypes entityType)

Set the entityType property: The mapping entity type.

Parameters:

entityType - the entityType value to set.

Returns:

the KpiDefinitionInner object itself.

withEntityTypeName

public KpiDefinitionInner withEntityTypeName(String entityTypeName)

Set the entityTypeName property: The mapping entity name.

Parameters:

entityTypeName - the entityTypeName value to set.

Returns:

the KpiDefinitionInner object itself.

withExpression

public KpiDefinitionInner withExpression(String expression)

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

Parameters:

expression - the expression value to set.

Returns:

the KpiDefinitionInner object itself.

withExtracts

public KpiDefinitionInner withExtracts(List extracts)

Set the extracts property: The KPI extracts.

Parameters:

extracts - the extracts value to set.

Returns:

the KpiDefinitionInner object itself.

withFilter

public KpiDefinitionInner withFilter(String filter)

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

Parameters:

filter - the filter value to set.

Returns:

the KpiDefinitionInner object itself.

withFunction

public KpiDefinitionInner withFunction(KpiFunctions function)

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

Parameters:

function - the function value to set.

Returns:

the KpiDefinitionInner object itself.

withGroupBy

public KpiDefinitionInner withGroupBy(List groupBy)

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

Parameters:

groupBy - the groupBy value to set.

Returns:

the KpiDefinitionInner object itself.

withThresHolds

public KpiDefinitionInner withThresHolds(KpiThresholds thresHolds)

Set the thresHolds property: The KPI thresholds.

Parameters:

thresHolds - the thresHolds value to set.

Returns:

the KpiDefinitionInner object itself.

withUnit

public KpiDefinitionInner withUnit(String unit)

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

Parameters:

unit - the unit value to set.

Returns:

the KpiDefinitionInner object itself.

Applies to