com.pulumi.azurenative.customerinsights.Kpi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.customerinsights;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.customerinsights.KpiArgs;
import com.pulumi.azurenative.customerinsights.outputs.KpiAliasResponse;
import com.pulumi.azurenative.customerinsights.outputs.KpiExtractResponse;
import com.pulumi.azurenative.customerinsights.outputs.KpiGroupByMetadataResponse;
import com.pulumi.azurenative.customerinsights.outputs.KpiParticipantProfilesMetadataResponse;
import com.pulumi.azurenative.customerinsights.outputs.KpiThresholdsResponse;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* The KPI resource format.
* Azure REST API version: 2017-04-26. Prior API version in Azure Native 1.x: 2017-04-26.
*
* ## Example Usage
* ### Kpi_CreateOrUpdate
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.customerinsights.Kpi;
* import com.pulumi.azurenative.customerinsights.KpiArgs;
* import com.pulumi.azurenative.customerinsights.inputs.KpiAliasArgs;
* import com.pulumi.azurenative.customerinsights.inputs.KpiThresholdsArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var kpi = new Kpi("kpi", KpiArgs.builder()
* .aliases(KpiAliasArgs.builder()
* .aliasName("alias")
* .expression("Id+4")
* .build())
* .calculationWindow("Day")
* .description(Map.of("en-us", "Kpi Description"))
* .displayName(Map.of("en-us", "Kpi DisplayName"))
* .entityType("Profile")
* .entityTypeName("testProfile2327128")
* .expression("SavingAccountBalance")
* .function("Sum")
* .groupBy("SavingAccountBalance")
* .hubName("sdkTestHub")
* .kpiName("kpiTest45453647")
* .resourceGroupName("TestHubRG")
* .thresHolds(KpiThresholdsArgs.builder()
* .increasingKpi(true)
* .lowerLimit(5)
* .upperLimit(50)
* .build())
* .unit("unit")
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:customerinsights:Kpi sdkTestHub/kpiTest45453647 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
* ```
*
*/
@ResourceType(type="azure-native:customerinsights:Kpi")
public class Kpi extends com.pulumi.resources.CustomResource {
/**
* The aliases.
*
*/
@Export(name="aliases", refs={List.class,KpiAliasResponse.class}, tree="[0,1]")
private Output> aliases;
/**
* @return The aliases.
*
*/
public Output>> aliases() {
return Codegen.optional(this.aliases);
}
/**
* The calculation window.
*
*/
@Export(name="calculationWindow", refs={String.class}, tree="[0]")
private Output calculationWindow;
/**
* @return The calculation window.
*
*/
public Output calculationWindow() {
return this.calculationWindow;
}
/**
* Name of calculation window field.
*
*/
@Export(name="calculationWindowFieldName", refs={String.class}, tree="[0]")
private Output calculationWindowFieldName;
/**
* @return Name of calculation window field.
*
*/
public Output> calculationWindowFieldName() {
return Codegen.optional(this.calculationWindowFieldName);
}
/**
* Localized description for the KPI.
*
*/
@Export(name="description", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> description;
/**
* @return Localized description for the KPI.
*
*/
public Output>> description() {
return Codegen.optional(this.description);
}
/**
* Localized display name for the KPI.
*
*/
@Export(name="displayName", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> displayName;
/**
* @return Localized display name for the KPI.
*
*/
public Output>> displayName() {
return Codegen.optional(this.displayName);
}
/**
* The mapping entity type.
*
*/
@Export(name="entityType", refs={String.class}, tree="[0]")
private Output entityType;
/**
* @return The mapping entity type.
*
*/
public Output entityType() {
return this.entityType;
}
/**
* The mapping entity name.
*
*/
@Export(name="entityTypeName", refs={String.class}, tree="[0]")
private Output entityTypeName;
/**
* @return The mapping entity name.
*
*/
public Output entityTypeName() {
return this.entityTypeName;
}
/**
* The computation expression for the KPI.
*
*/
@Export(name="expression", refs={String.class}, tree="[0]")
private Output expression;
/**
* @return The computation expression for the KPI.
*
*/
public Output expression() {
return this.expression;
}
/**
* The KPI extracts.
*
*/
@Export(name="extracts", refs={List.class,KpiExtractResponse.class}, tree="[0,1]")
private Output> extracts;
/**
* @return The KPI extracts.
*
*/
public Output>> extracts() {
return Codegen.optional(this.extracts);
}
/**
* The filter expression for the KPI.
*
*/
@Export(name="filter", refs={String.class}, tree="[0]")
private Output filter;
/**
* @return The filter expression for the KPI.
*
*/
public Output> filter() {
return Codegen.optional(this.filter);
}
/**
* The computation function for the KPI.
*
*/
@Export(name="function", refs={String.class}, tree="[0]")
private Output function;
/**
* @return The computation function for the KPI.
*
*/
public Output function() {
return this.function;
}
/**
* the group by properties for the KPI.
*
*/
@Export(name="groupBy", refs={List.class,String.class}, tree="[0,1]")
private Output> groupBy;
/**
* @return the group by properties for the KPI.
*
*/
public Output>> groupBy() {
return Codegen.optional(this.groupBy);
}
/**
* The KPI GroupByMetadata.
*
*/
@Export(name="groupByMetadata", refs={List.class,KpiGroupByMetadataResponse.class}, tree="[0,1]")
private Output> groupByMetadata;
/**
* @return The KPI GroupByMetadata.
*
*/
public Output> groupByMetadata() {
return this.groupByMetadata;
}
/**
* The KPI name.
*
*/
@Export(name="kpiName", refs={String.class}, tree="[0]")
private Output kpiName;
/**
* @return The KPI name.
*
*/
public Output kpiName() {
return this.kpiName;
}
/**
* Resource name.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Resource name.
*
*/
public Output name() {
return this.name;
}
/**
* The participant profiles.
*
*/
@Export(name="participantProfilesMetadata", refs={List.class,KpiParticipantProfilesMetadataResponse.class}, tree="[0,1]")
private Output> participantProfilesMetadata;
/**
* @return The participant profiles.
*
*/
public Output> participantProfilesMetadata() {
return this.participantProfilesMetadata;
}
/**
* Provisioning state.
*
*/
@Export(name="provisioningState", refs={String.class}, tree="[0]")
private Output provisioningState;
/**
* @return Provisioning state.
*
*/
public Output provisioningState() {
return this.provisioningState;
}
/**
* The hub name.
*
*/
@Export(name="tenantId", refs={String.class}, tree="[0]")
private Output tenantId;
/**
* @return The hub name.
*
*/
public Output tenantId() {
return this.tenantId;
}
/**
* The KPI thresholds.
*
*/
@Export(name="thresHolds", refs={KpiThresholdsResponse.class}, tree="[0]")
private Output thresHolds;
/**
* @return The KPI thresholds.
*
*/
public Output> thresHolds() {
return Codegen.optional(this.thresHolds);
}
/**
* Resource type.
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return Resource type.
*
*/
public Output type() {
return this.type;
}
/**
* The unit of measurement for the KPI.
*
*/
@Export(name="unit", refs={String.class}, tree="[0]")
private Output unit;
/**
* @return The unit of measurement for the KPI.
*
*/
public Output> unit() {
return Codegen.optional(this.unit);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Kpi(java.lang.String name) {
this(name, KpiArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Kpi(java.lang.String name, KpiArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Kpi(java.lang.String name, KpiArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:customerinsights:Kpi", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Kpi(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:customerinsights:Kpi", name, null, makeResourceOptions(options, id), false);
}
private static KpiArgs makeArgs(KpiArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? KpiArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:customerinsights/v20170101:Kpi").build()),
Output.of(Alias.builder().type("azure-native:customerinsights/v20170426:Kpi").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Kpi get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Kpi(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy