Package com.azure.resourcemanager.customerinsights.fluent.models

Class KpiDefinitionInner

java.lang.Object
com.azure.resourcemanager.customerinsights.fluent.models.KpiDefinitionInner
Direct Known Subclasses:
EnrichingKpi
public class KpiDefinitionInner extends Object
Defines the KPI Threshold limits.

  • Constructor Details

    • KpiDefinitionInner

      public KpiDefinitionInner()
      Creates an instance of KpiDefinitionInner class.

  • Method Details

    • entityType

      public EntityTypes entityType()
      Get the entityType property: The mapping entity type.
      Returns:
      the entityType value.

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

    • entityTypeName

      public String entityTypeName()
      Get the entityTypeName property: The mapping entity name.
      Returns:
      the entityTypeName value.

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

    • tenantId

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

    • kpiName

      public String kpiName()
      Get the kpiName property: The KPI name.
      Returns:
      the kpiName value.

    • displayName

      public Map<String,String> displayName()
      Get the displayName property: Localized display name for the KPI.
      Returns:
      the displayName value.

    • withDisplayName

      public KpiDefinitionInner withDisplayName(Map<String,String> displayName)
      Set the displayName property: Localized display name for the KPI.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • description

      public Map<String,String> description()
      Get the description property: Localized description for the KPI.
      Returns:
      the description value.

    • withDescription

      public KpiDefinitionInner withDescription(Map<String,String> description)
      Set the description property: Localized description for the KPI.
      Parameters:
      description - the description value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • calculationWindow

      public CalculationWindowTypes calculationWindow()
      Get the calculationWindow property: The calculation window.
      Returns:
      the calculationWindow value.

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

    • calculationWindowFieldName

      public String calculationWindowFieldName()
      Get the calculationWindowFieldName property: Name of calculation window field.
      Returns:
      the calculationWindowFieldName value.

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

    • function

      public KpiFunctions function()
      Get the function property: The computation function for the KPI.
      Returns:
      the function value.

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

    • expression

      public String expression()
      Get the expression property: The computation expression for the KPI.
      Returns:
      the expression value.

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

    • unit

      public String unit()
      Get the unit property: The unit of measurement for the KPI.
      Returns:
      the unit value.

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

    • filter

      public String filter()
      Get the filter property: The filter expression for the KPI.
      Returns:
      the filter value.

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

    • groupBy

      public List<String> groupBy()
      Get the groupBy property: the group by properties for the KPI.
      Returns:
      the groupBy value.

    • withGroupBy

      public KpiDefinitionInner withGroupBy(List<String> groupBy)
      Set the groupBy property: the group by properties for the KPI.
      Parameters:
      groupBy - the groupBy value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • groupByMetadata

      public List<KpiGroupByMetadata> groupByMetadata()
      Get the groupByMetadata property: The KPI GroupByMetadata.
      Returns:
      the groupByMetadata value.

    • participantProfilesMetadata

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

    • thresHolds

      public KpiThresholds thresHolds()
      Get the thresHolds property: The KPI thresholds.
      Returns:
      the thresHolds value.

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

    • aliases

      public List<KpiAlias> aliases()
      Get the aliases property: The aliases.
      Returns:
      the aliases value.

    • withAliases

      public KpiDefinitionInner withAliases(List<KpiAlias> aliases)
      Set the aliases property: The aliases.
      Parameters:
      aliases - the aliases value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • extracts

      public List<KpiExtract> extracts()
      Get the extracts property: The KPI extracts.
      Returns:
      the extracts value.

    • withExtracts

      public KpiDefinitionInner withExtracts(List<KpiExtract> extracts)
      Set the extracts property: The KPI extracts.
      Parameters:
      extracts - the extracts value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.