Package com.azure.resourcemanager.customerinsights.models

Interface KpiDefinition

public interface KpiDefinition
An immutable client-side representation of KpiDefinition.

  • Method Details

    • entityType

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

    • entityTypeName

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

    • tenantId

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

    • kpiName

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

    • displayName

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

    • description

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

    • calculationWindow

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

    • calculationWindowFieldName

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

    • function

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

    • expression

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

    • unit

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

    • filter

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

    • groupBy

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

    • groupByMetadata

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

    • participantProfilesMetadata

      List<KpiParticipantProfilesMetadata> participantProfilesMetadata()
      Gets the participantProfilesMetadata property: The participant profiles.
      Returns:
      the participantProfilesMetadata value.

    • provisioningState

      ProvisioningStates provisioningState()
      Gets the provisioningState property: Provisioning state.
      Returns:
      the provisioningState value.

    • thresHolds

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

    • aliases

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

    • extracts

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

    • innerModel

      KpiDefinitionInner innerModel()
      Gets the inner com.azure.resourcemanager.customerinsights.fluent.models.KpiDefinitionInner object.
      Returns:
      the inner object.