com.pulumi.gcp.monitoring.kotlin.MetricDescriptorArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.monitoring.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.monitoring.MetricDescriptorArgs.builder
import com.pulumi.gcp.monitoring.kotlin.inputs.MetricDescriptorLabelArgs
import com.pulumi.gcp.monitoring.kotlin.inputs.MetricDescriptorLabelArgsBuilder
import com.pulumi.gcp.monitoring.kotlin.inputs.MetricDescriptorMetadataArgs
import com.pulumi.gcp.monitoring.kotlin.inputs.MetricDescriptorMetadataArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
* To get more information about MetricDescriptor, see:
* * [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/monitoring/custom-metrics/)
* ## Example Usage
* ### Monitoring Metric Descriptor Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const basic = new gcp.monitoring.MetricDescriptor("basic", {
* description: "Daily sales records from all branch stores.",
* displayName: "metric-descriptor",
* type: "custom.googleapis.com/stores/daily_sales",
* metricKind: "GAUGE",
* valueType: "DOUBLE",
* unit: "{USD}",
* labels: [{
* key: "store_id",
* valueType: "STRING",
* description: "The ID of the store.",
* }],
* launchStage: "BETA",
* metadata: {
* samplePeriod: "60s",
* ingestDelay: "30s",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* basic = gcp.monitoring.MetricDescriptor("basic",
* description="Daily sales records from all branch stores.",
* display_name="metric-descriptor",
* type="custom.googleapis.com/stores/daily_sales",
* metric_kind="GAUGE",
* value_type="DOUBLE",
* unit="{USD}",
* labels=[gcp.monitoring.MetricDescriptorLabelArgs(
* key="store_id",
* value_type="STRING",
* description="The ID of the store.",
* )],
* launch_stage="BETA",
* metadata=gcp.monitoring.MetricDescriptorMetadataArgs(
* sample_period="60s",
* ingest_delay="30s",
* ))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var basic = new Gcp.Monitoring.MetricDescriptor("basic", new()
* {
* Description = "Daily sales records from all branch stores.",
* DisplayName = "metric-descriptor",
* Type = "custom.googleapis.com/stores/daily_sales",
* MetricKind = "GAUGE",
* ValueType = "DOUBLE",
* Unit = "{USD}",
* Labels = new[]
* {
* new Gcp.Monitoring.Inputs.MetricDescriptorLabelArgs
* {
* Key = "store_id",
* ValueType = "STRING",
* Description = "The ID of the store.",
* },
* },
* LaunchStage = "BETA",
* Metadata = new Gcp.Monitoring.Inputs.MetricDescriptorMetadataArgs
* {
* SamplePeriod = "60s",
* IngestDelay = "30s",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/monitoring"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := monitoring.NewMetricDescriptor(ctx, "basic", &monitoring.MetricDescriptorArgs{
* Description: pulumi.String("Daily sales records from all branch stores."),
* DisplayName: pulumi.String("metric-descriptor"),
* Type: pulumi.String("custom.googleapis.com/stores/daily_sales"),
* MetricKind: pulumi.String("GAUGE"),
* ValueType: pulumi.String("DOUBLE"),
* Unit: pulumi.String("{USD}"),
* Labels: monitoring.MetricDescriptorLabelArray{
* &monitoring.MetricDescriptorLabelArgs{
* Key: pulumi.String("store_id"),
* ValueType: pulumi.String("STRING"),
* Description: pulumi.String("The ID of the store."),
* },
* },
* LaunchStage: pulumi.String("BETA"),
* Metadata: &monitoring.MetricDescriptorMetadataArgs{
* SamplePeriod: pulumi.String("60s"),
* IngestDelay: pulumi.String("30s"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.monitoring.MetricDescriptor;
* import com.pulumi.gcp.monitoring.MetricDescriptorArgs;
* import com.pulumi.gcp.monitoring.inputs.MetricDescriptorLabelArgs;
* import com.pulumi.gcp.monitoring.inputs.MetricDescriptorMetadataArgs;
* 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 basic = new MetricDescriptor("basic", MetricDescriptorArgs.builder()
* .description("Daily sales records from all branch stores.")
* .displayName("metric-descriptor")
* .type("custom.googleapis.com/stores/daily_sales")
* .metricKind("GAUGE")
* .valueType("DOUBLE")
* .unit("{USD}")
* .labels(MetricDescriptorLabelArgs.builder()
* .key("store_id")
* .valueType("STRING")
* .description("The ID of the store.")
* .build())
* .launchStage("BETA")
* .metadata(MetricDescriptorMetadataArgs.builder()
* .samplePeriod("60s")
* .ingestDelay("30s")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* basic:
* type: gcp:monitoring:MetricDescriptor
* properties:
* description: Daily sales records from all branch stores.
* displayName: metric-descriptor
* type: custom.googleapis.com/stores/daily_sales
* metricKind: GAUGE
* valueType: DOUBLE
* unit: '{USD}'
* labels:
* - key: store_id
* valueType: STRING
* description: The ID of the store.
* launchStage: BETA
* metadata:
* samplePeriod: 60s
* ingestDelay: 30s
* ```
*
* ### Monitoring Metric Descriptor Alert
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const withAlert = new gcp.monitoring.MetricDescriptor("with_alert", {
* description: "Daily sales records from all branch stores.",
* displayName: "metric-descriptor",
* type: "custom.googleapis.com/stores/daily_sales",
* metricKind: "GAUGE",
* valueType: "DOUBLE",
* unit: "{USD}",
* });
* const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", {
* displayName: "metric-descriptor",
* combiner: "OR",
* conditions: [{
* displayName: "test condition",
* conditionThreshold: {
* filter: pulumi.interpolate`metric.type="${withAlert.type}" AND resource.type="gce_instance"`,
* duration: "60s",
* comparison: "COMPARISON_GT",
* },
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* with_alert = gcp.monitoring.MetricDescriptor("with_alert",
* description="Daily sales records from all branch stores.",
* display_name="metric-descriptor",
* type="custom.googleapis.com/stores/daily_sales",
* metric_kind="GAUGE",
* value_type="DOUBLE",
* unit="{USD}")
* alert_policy = gcp.monitoring.AlertPolicy("alert_policy",
* display_name="metric-descriptor",
* combiner="OR",
* conditions=[gcp.monitoring.AlertPolicyConditionArgs(
* display_name="test condition",
* condition_threshold=gcp.monitoring.AlertPolicyConditionConditionThresholdArgs(
* filter=with_alert.type.apply(lambda type: f"metric.type=\"{type}\" AND resource.type=\"gce_instance\""),
* duration="60s",
* comparison="COMPARISON_GT",
* ),
* )])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var withAlert = new Gcp.Monitoring.MetricDescriptor("with_alert", new()
* {
* Description = "Daily sales records from all branch stores.",
* DisplayName = "metric-descriptor",
* Type = "custom.googleapis.com/stores/daily_sales",
* MetricKind = "GAUGE",
* ValueType = "DOUBLE",
* Unit = "{USD}",
* });
* var alertPolicy = new Gcp.Monitoring.AlertPolicy("alert_policy", new()
* {
* DisplayName = "metric-descriptor",
* Combiner = "OR",
* Conditions = new[]
* {
* new Gcp.Monitoring.Inputs.AlertPolicyConditionArgs
* {
* DisplayName = "test condition",
* ConditionThreshold = new Gcp.Monitoring.Inputs.AlertPolicyConditionConditionThresholdArgs
* {
* Filter = withAlert.Type.Apply(type => $"metric.type=\"{type}\" AND resource.type=\"gce_instance\""),
* Duration = "60s",
* Comparison = "COMPARISON_GT",
* },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/monitoring"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* withAlert, err := monitoring.NewMetricDescriptor(ctx, "with_alert", &monitoring.MetricDescriptorArgs{
* Description: pulumi.String("Daily sales records from all branch stores."),
* DisplayName: pulumi.String("metric-descriptor"),
* Type: pulumi.String("custom.googleapis.com/stores/daily_sales"),
* MetricKind: pulumi.String("GAUGE"),
* ValueType: pulumi.String("DOUBLE"),
* Unit: pulumi.String("{USD}"),
* })
* if err != nil {
* return err
* }
* _, err = monitoring.NewAlertPolicy(ctx, "alert_policy", &monitoring.AlertPolicyArgs{
* DisplayName: pulumi.String("metric-descriptor"),
* Combiner: pulumi.String("OR"),
* Conditions: monitoring.AlertPolicyConditionArray{
* &monitoring.AlertPolicyConditionArgs{
* DisplayName: pulumi.String("test condition"),
* ConditionThreshold: &monitoring.AlertPolicyConditionConditionThresholdArgs{
* Filter: withAlert.Type.ApplyT(func(_type string) (string, error) {
* return fmt.Sprintf("metric.type=\"%v\" AND resource.type=\"gce_instance\"", _type), nil
* }).(pulumi.StringOutput),
* Duration: pulumi.String("60s"),
* Comparison: pulumi.String("COMPARISON_GT"),
* },
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.monitoring.MetricDescriptor;
* import com.pulumi.gcp.monitoring.MetricDescriptorArgs;
* import com.pulumi.gcp.monitoring.AlertPolicy;
* import com.pulumi.gcp.monitoring.AlertPolicyArgs;
* import com.pulumi.gcp.monitoring.inputs.AlertPolicyConditionArgs;
* import com.pulumi.gcp.monitoring.inputs.AlertPolicyConditionConditionThresholdArgs;
* 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 withAlert = new MetricDescriptor("withAlert", MetricDescriptorArgs.builder()
* .description("Daily sales records from all branch stores.")
* .displayName("metric-descriptor")
* .type("custom.googleapis.com/stores/daily_sales")
* .metricKind("GAUGE")
* .valueType("DOUBLE")
* .unit("{USD}")
* .build());
* var alertPolicy = new AlertPolicy("alertPolicy", AlertPolicyArgs.builder()
* .displayName("metric-descriptor")
* .combiner("OR")
* .conditions(AlertPolicyConditionArgs.builder()
* .displayName("test condition")
* .conditionThreshold(AlertPolicyConditionConditionThresholdArgs.builder()
* .filter(withAlert.type().applyValue(type -> String.format("metric.type=\"%s\" AND resource.type=\"gce_instance\"", type)))
* .duration("60s")
* .comparison("COMPARISON_GT")
* .build())
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* withAlert:
* type: gcp:monitoring:MetricDescriptor
* name: with_alert
* properties:
* description: Daily sales records from all branch stores.
* displayName: metric-descriptor
* type: custom.googleapis.com/stores/daily_sales
* metricKind: GAUGE
* valueType: DOUBLE
* unit: '{USD}'
* alertPolicy:
* type: gcp:monitoring:AlertPolicy
* name: alert_policy
* properties:
* displayName: metric-descriptor
* combiner: OR
* conditions:
* - displayName: test condition
* conditionThreshold:
* filter: metric.type="${withAlert.type}" AND resource.type="gce_instance"
* duration: 60s
* comparison: COMPARISON_GT
* ```
*
* ## Import
* MetricDescriptor can be imported using any of these accepted formats:
* * `{{name}}`
* When using the `pulumi import` command, MetricDescriptor can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:monitoring/metricDescriptor:MetricDescriptor default {{name}}
* ```
* @property description A detailed description of the metric, which can be used in documentation.
* @property displayName A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
* - - -
* @property labels The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels.
* Structure is documented below.
* @property launchStage The launch stage of the metric definition.
* Possible values are: `LAUNCH_STAGE_UNSPECIFIED`, `UNIMPLEMENTED`, `PRELAUNCH`, `EARLY_ACCESS`, `ALPHA`, `BETA`, `GA`, `DEPRECATED`.
* @property metadata Metadata which can be used to guide usage of the metric.
* Structure is documented below.
* @property metricKind Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metricKind and valueType might not be supported.
* Possible values are: `METRIC_KIND_UNSPECIFIED`, `GAUGE`, `DELTA`, `CUMULATIVE`.
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
* @property type The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must have only upper and lower-case letters, digits, '/' and underscores '_' are allowed. Additionally, the maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.
* @property unit The units in which the metric value is reported. It is only applicable if the
* valueType is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of
* the stored metric values.
* Different systems may scale the values to be more easily displayed (so a value of
* 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as
* 3.5MBy). However, if the unit is KBy, then the value of the metric is always in
* thousands of bytes, no matter how it may be displayed.
* If you want a custom metric to record the exact number of CPU-seconds used by a job,
* you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently
* 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as
* 12005.
* Alternatively, if you want a custom metric to record data in a more granular way, you
* can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value
* 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).
* The supported units are a subset of The Unified Code for Units of Measure standard.
* More info can be found in the API documentation
* (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors).
* @property valueType Whether the measurement is an integer, a floating-point number, etc. Some combinations of metricKind and valueType might not be supported.
* Possible values are: `BOOL`, `INT64`, `DOUBLE`, `STRING`, `DISTRIBUTION`.
*/
public data class MetricDescriptorArgs(
public val description: Output? = null,
public val displayName: Output? = null,
public val labels: Output>? = null,
public val launchStage: Output? = null,
public val metadata: Output? = null,
public val metricKind: Output? = null,
public val project: Output? = null,
public val type: Output? = null,
public val unit: Output? = null,
public val valueType: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.monitoring.MetricDescriptorArgs =
com.pulumi.gcp.monitoring.MetricDescriptorArgs.builder()
.description(description?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.labels(labels?.applyValue({ args0 -> args0.map({ args0 -> args0.let({ args0 -> args0.toJava() }) }) }))
.launchStage(launchStage?.applyValue({ args0 -> args0 }))
.metadata(metadata?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.metricKind(metricKind?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 }))
.type(type?.applyValue({ args0 -> args0 }))
.unit(unit?.applyValue({ args0 -> args0 }))
.valueType(valueType?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [MetricDescriptorArgs].
*/
@PulumiTagMarker
public class MetricDescriptorArgsBuilder internal constructor() {
private var description: Output? = null
private var displayName: Output? = null
private var labels: Output>? = null
private var launchStage: Output? = null
private var metadata: Output? = null
private var metricKind: Output? = null
private var project: Output? = null
private var type: Output? = null
private var unit: Output? = null
private var valueType: Output? = null
/**
* @param value A detailed description of the metric, which can be used in documentation.
*/
@JvmName("efwwpksniebdfibn")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
* - - -
*/
@JvmName("arkipxhdwmywyahe")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels.
* Structure is documented below.
*/
@JvmName("enlriyhstbcrclph")
public suspend fun labels(`value`: Output>) {
this.labels = value
}
@JvmName("brxjglaldtwiqdbm")
public suspend fun labels(vararg values: Output) {
this.labels = Output.all(values.asList())
}
/**
* @param values The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels.
* Structure is documented below.
*/
@JvmName("ntkflmsyovctawnq")
public suspend fun labels(values: List>) {
this.labels = Output.all(values)
}
/**
* @param value The launch stage of the metric definition.
* Possible values are: `LAUNCH_STAGE_UNSPECIFIED`, `UNIMPLEMENTED`, `PRELAUNCH`, `EARLY_ACCESS`, `ALPHA`, `BETA`, `GA`, `DEPRECATED`.
*/
@JvmName("kgllnitgbkhhvwwd")
public suspend fun launchStage(`value`: Output) {
this.launchStage = value
}
/**
* @param value Metadata which can be used to guide usage of the metric.
* Structure is documented below.
*/
@JvmName("ixhwvakrewqntwwt")
public suspend fun metadata(`value`: Output) {
this.metadata = value
}
/**
* @param value Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metricKind and valueType might not be supported.
* Possible values are: `METRIC_KIND_UNSPECIFIED`, `GAUGE`, `DELTA`, `CUMULATIVE`.
*/
@JvmName("ltmlqlpytnaicnpi")
public suspend fun metricKind(`value`: Output) {
this.metricKind = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("auynyhbfouttlsyo")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must have only upper and lower-case letters, digits, '/' and underscores '_' are allowed. Additionally, the maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.
*/
@JvmName("mevsgpmqbupwwnys")
public suspend fun type(`value`: Output) {
this.type = value
}
/**
* @param value The units in which the metric value is reported. It is only applicable if the
* valueType is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of
* the stored metric values.
* Different systems may scale the values to be more easily displayed (so a value of
* 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as
* 3.5MBy). However, if the unit is KBy, then the value of the metric is always in
* thousands of bytes, no matter how it may be displayed.
* If you want a custom metric to record the exact number of CPU-seconds used by a job,
* you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently
* 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as
* 12005.
* Alternatively, if you want a custom metric to record data in a more granular way, you
* can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value
* 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).
* The supported units are a subset of The Unified Code for Units of Measure standard.
* More info can be found in the API documentation
* (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors).
*/
@JvmName("qagcrqgxntsfauty")
public suspend fun unit(`value`: Output) {
this.unit = value
}
/**
* @param value Whether the measurement is an integer, a floating-point number, etc. Some combinations of metricKind and valueType might not be supported.
* Possible values are: `BOOL`, `INT64`, `DOUBLE`, `STRING`, `DISTRIBUTION`.
*/
@JvmName("qxojpcyekrucvedj")
public suspend fun valueType(`value`: Output) {
this.valueType = value
}
/**
* @param value A detailed description of the metric, which can be used in documentation.
*/
@JvmName("bwbelstyvhtxbxsi")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
* - - -
*/
@JvmName("hcmaraoxggylyuoj")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels.
* Structure is documented below.
*/
@JvmName("yufciflihtauvqnq")
public suspend fun labels(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param argument The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels.
* Structure is documented below.
*/
@JvmName("aucluegctyqelnro")
public suspend fun labels(argument: List Unit>) {
val toBeMapped = argument.toList().map {
MetricDescriptorLabelArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.labels = mapped
}
/**
* @param argument The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels.
* Structure is documented below.
*/
@JvmName("gvsqnwvekdigduyj")
public suspend fun labels(vararg argument: suspend MetricDescriptorLabelArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
MetricDescriptorLabelArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.labels = mapped
}
/**
* @param argument The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels.
* Structure is documented below.
*/
@JvmName("capmhuucgketdbtk")
public suspend fun labels(argument: suspend MetricDescriptorLabelArgsBuilder.() -> Unit) {
val toBeMapped = listOf(MetricDescriptorLabelArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.labels = mapped
}
/**
* @param values The set of labels that can be used to describe a specific instance of this metric type. In order to delete a label, the entire resource must be deleted, then created with the desired labels.
* Structure is documented below.
*/
@JvmName("jekhgfifatygjnuy")
public suspend fun labels(vararg values: MetricDescriptorLabelArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param value The launch stage of the metric definition.
* Possible values are: `LAUNCH_STAGE_UNSPECIFIED`, `UNIMPLEMENTED`, `PRELAUNCH`, `EARLY_ACCESS`, `ALPHA`, `BETA`, `GA`, `DEPRECATED`.
*/
@JvmName("qjiaghsxfywklxgw")
public suspend fun launchStage(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.launchStage = mapped
}
/**
* @param value Metadata which can be used to guide usage of the metric.
* Structure is documented below.
*/
@JvmName("imghobdrdfoluqrg")
public suspend fun metadata(`value`: MetricDescriptorMetadataArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.metadata = mapped
}
/**
* @param argument Metadata which can be used to guide usage of the metric.
* Structure is documented below.
*/
@JvmName("driltitatjciwpui")
public suspend fun metadata(argument: suspend MetricDescriptorMetadataArgsBuilder.() -> Unit) {
val toBeMapped = MetricDescriptorMetadataArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.metadata = mapped
}
/**
* @param value Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metricKind and valueType might not be supported.
* Possible values are: `METRIC_KIND_UNSPECIFIED`, `GAUGE`, `DELTA`, `CUMULATIVE`.
*/
@JvmName("tgjsawffjgcvekee")
public suspend fun metricKind(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.metricKind = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("xoeqsnxcpeqewauc")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must have only upper and lower-case letters, digits, '/' and underscores '_' are allowed. Additionally, the maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.
*/
@JvmName("qkocjwttvtuswyat")
public suspend fun type(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.type = mapped
}
/**
* @param value The units in which the metric value is reported. It is only applicable if the
* valueType is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of
* the stored metric values.
* Different systems may scale the values to be more easily displayed (so a value of
* 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as
* 3.5MBy). However, if the unit is KBy, then the value of the metric is always in
* thousands of bytes, no matter how it may be displayed.
* If you want a custom metric to record the exact number of CPU-seconds used by a job,
* you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently
* 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as
* 12005.
* Alternatively, if you want a custom metric to record data in a more granular way, you
* can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value
* 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).
* The supported units are a subset of The Unified Code for Units of Measure standard.
* More info can be found in the API documentation
* (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors).
*/
@JvmName("hkxjohttgrebxeum")
public suspend fun unit(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.unit = mapped
}
/**
* @param value Whether the measurement is an integer, a floating-point number, etc. Some combinations of metricKind and valueType might not be supported.
* Possible values are: `BOOL`, `INT64`, `DOUBLE`, `STRING`, `DISTRIBUTION`.
*/
@JvmName("nlrfsobapakmdcdq")
public suspend fun valueType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.valueType = mapped
}
internal fun build(): MetricDescriptorArgs = MetricDescriptorArgs(
description = description,
displayName = displayName,
labels = labels,
launchStage = launchStage,
metadata = metadata,
metricKind = metricKind,
project = project,
type = type,
unit = unit,
valueType = valueType,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy