Package com.azure.resourcemanager.customerinsights.models

Class EnrichingKpi

java.lang.Object
com.azure.resourcemanager.customerinsights.fluent.models.KpiDefinitionInner
com.azure.resourcemanager.customerinsights.models.EnrichingKpi
public final class EnrichingKpi extends KpiDefinitionInner
The enriching KPI definition.

  • Constructor Details

    • EnrichingKpi

      public EnrichingKpi()
      Creates an instance of EnrichingKpi class.

  • Method Details

    • withEntityType

      public EnrichingKpi withEntityType(EntityTypes entityType)
      Set the entityType property: The mapping entity type.
      Overrides:
      withEntityType in class KpiDefinitionInner
      Parameters:
      entityType - the entityType value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withEntityTypeName

      public EnrichingKpi withEntityTypeName(String entityTypeName)
      Set the entityTypeName property: The mapping entity name.
      Overrides:
      withEntityTypeName in class KpiDefinitionInner
      Parameters:
      entityTypeName - the entityTypeName value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withDisplayName

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

    • withDescription

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

    • withCalculationWindow

      public EnrichingKpi withCalculationWindow(CalculationWindowTypes calculationWindow)
      Set the calculationWindow property: The calculation window.
      Overrides:
      withCalculationWindow in class KpiDefinitionInner
      Parameters:
      calculationWindow - the calculationWindow value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withCalculationWindowFieldName

      public EnrichingKpi withCalculationWindowFieldName(String calculationWindowFieldName)
      Set the calculationWindowFieldName property: Name of calculation window field.
      Overrides:
      withCalculationWindowFieldName in class KpiDefinitionInner
      Parameters:
      calculationWindowFieldName - the calculationWindowFieldName value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withFunction

      public EnrichingKpi withFunction(KpiFunctions function)
      Set the function property: The computation function for the KPI.
      Overrides:
      withFunction in class KpiDefinitionInner
      Parameters:
      function - the function value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withExpression

      public EnrichingKpi withExpression(String expression)
      Set the expression property: The computation expression for the KPI.
      Overrides:
      withExpression in class KpiDefinitionInner
      Parameters:
      expression - the expression value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withUnit

      public EnrichingKpi withUnit(String unit)
      Set the unit property: The unit of measurement for the KPI.
      Overrides:
      withUnit in class KpiDefinitionInner
      Parameters:
      unit - the unit value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withFilter

      public EnrichingKpi withFilter(String filter)
      Set the filter property: The filter expression for the KPI.
      Overrides:
      withFilter in class KpiDefinitionInner
      Parameters:
      filter - the filter value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withGroupBy

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

    • withThresHolds

      public EnrichingKpi withThresHolds(KpiThresholds thresHolds)
      Set the thresHolds property: The KPI thresholds.
      Overrides:
      withThresHolds in class KpiDefinitionInner
      Parameters:
      thresHolds - the thresHolds value to set.
      Returns:
      the KpiDefinitionInner object itself.

    • withAliases

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

    • withExtracts

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

    • validate

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