class Azure::CustomerInsights::Mgmt::V2017_01_01::Models::KpiResourceFormat
The KPI resource format.
Attributes
@return [Array<KpiAlias>] The aliases.
@return [CalculationWindowTypes] The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month'
@return [String] Name of calculation window field.
@return [Hash{String => String}] Localized description for the KPI.
@return [Hash{String => String}] Localized display name for the KPI.
@return [EntityTypes] The mapping entity type. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'
@return [String] The mapping entity name.
@return [String] The computation expression for the KPI.
@return [Array<KpiExtract>] The KPI extracts.
@return [String] The filter expression for the KPI.
@return [KpiFunctions] The computation function for the KPI. Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', 'None', 'CountDistinct'
@return [Array<String>] the group by properties for the KPI.
@return [Array<KpiGroupByMetadata>] The KPI GroupByMetadata.
@return [String] The KPI name.
@return [Array<KpiParticipantProfilesMetadata>] The participant profiles.
@return [ProvisioningStates] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed'
@return [String] The hub name.
@return [KpiThresholds] The KPI thresholds.
@return [String] The unit of measurement for the KPI.
Public Class Methods
Mapper for KpiResourceFormat
class as Ruby Hash. This will be used for serialization/deserialization.
# File lib/2017-01-01/generated/azure_mgmt_customer_insights/models/kpi_resource_format.rb, line 84 def self.mapper() { client_side_validation: true, required: false, serialized_name: 'KpiResourceFormat', type: { name: 'Composite', class_name: 'KpiResourceFormat', model_properties: { id: { client_side_validation: true, required: false, read_only: true, serialized_name: 'id', type: { name: 'String' } }, name: { client_side_validation: true, required: false, read_only: true, serialized_name: 'name', type: { name: 'String' } }, type: { client_side_validation: true, required: false, read_only: true, serialized_name: 'type', type: { name: 'String' } }, entity_type: { client_side_validation: true, required: true, serialized_name: 'properties.entityType', type: { name: 'Enum', module: 'EntityTypes' } }, entity_type_name: { client_side_validation: true, required: true, serialized_name: 'properties.entityTypeName', type: { name: 'String' } }, tenant_id: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.tenantId', type: { name: 'String' } }, kpi_name: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.kpiName', type: { name: 'String' } }, display_name: { client_side_validation: true, required: false, serialized_name: 'properties.displayName', type: { name: 'Dictionary', value: { client_side_validation: true, required: false, serialized_name: 'StringElementType', type: { name: 'String' } } } }, description: { client_side_validation: true, required: false, serialized_name: 'properties.description', type: { name: 'Dictionary', value: { client_side_validation: true, required: false, serialized_name: 'StringElementType', type: { name: 'String' } } } }, calculation_window: { client_side_validation: true, required: true, serialized_name: 'properties.calculationWindow', type: { name: 'Enum', module: 'CalculationWindowTypes' } }, calculation_window_field_name: { client_side_validation: true, required: false, serialized_name: 'properties.calculationWindowFieldName', type: { name: 'String' } }, function: { client_side_validation: true, required: true, serialized_name: 'properties.function', type: { name: 'Enum', module: 'KpiFunctions' } }, expression: { client_side_validation: true, required: true, serialized_name: 'properties.expression', type: { name: 'String' } }, unit: { client_side_validation: true, required: false, serialized_name: 'properties.unit', type: { name: 'String' } }, filter: { client_side_validation: true, required: false, serialized_name: 'properties.filter', type: { name: 'String' } }, group_by: { client_side_validation: true, required: false, serialized_name: 'properties.groupBy', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'StringElementType', type: { name: 'String' } } } }, group_by_metadata: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.groupByMetadata', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'KpiGroupByMetadataElementType', type: { name: 'Composite', class_name: 'KpiGroupByMetadata' } } } }, participant_profiles_metadata: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.participantProfilesMetadata', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'KpiParticipantProfilesMetadataElementType', type: { name: 'Composite', class_name: 'KpiParticipantProfilesMetadata' } } } }, provisioning_state: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.provisioningState', type: { name: 'String' } }, thres_holds: { client_side_validation: true, required: false, serialized_name: 'properties.thresHolds', type: { name: 'Composite', class_name: 'KpiThresholds' } }, aliases: { client_side_validation: true, required: false, serialized_name: 'properties.aliases', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'KpiAliasElementType', type: { name: 'Composite', class_name: 'KpiAlias' } } } }, extracts: { client_side_validation: true, required: false, serialized_name: 'properties.extracts', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'KpiExtractElementType', type: { name: 'Composite', class_name: 'KpiExtract' } } } } } } } end