Package-level declarations

Types

Link copied to clipboard
class AlertPolicy : KotlinCustomResource

A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. To get more information about AlertPolicy, see:

Link copied to clipboard
data class AlertPolicyArgs(val alertStrategy: Output<AlertPolicyAlertStrategyArgs>? = null, val combiner: Output<String>? = null, val conditions: Output<List<AlertPolicyConditionArgs>>? = null, val displayName: Output<String>? = null, val documentation: Output<AlertPolicyDocumentationArgs>? = null, val enabled: Output<Boolean>? = null, val notificationChannels: Output<List<String>>? = null, val project: Output<String>? = null, val severity: Output<String>? = null, val userLabels: Output<Map<String, String>>? = null) : ConvertibleToJava<AlertPolicyArgs>

A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. To get more information about AlertPolicy, see:

Link copied to clipboard
Link copied to clipboard
object AlertPolicyMapper : ResourceMapper<AlertPolicy>
Link copied to clipboard
Link copied to clipboard
class CustomService : KotlinCustomResource

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern. In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible To get more information about Service, see:

Link copied to clipboard
data class CustomServiceArgs(val displayName: Output<String>? = null, val project: Output<String>? = null, val serviceId: Output<String>? = null, val telemetry: Output<CustomServiceTelemetryArgs>? = null, val userLabels: Output<Map<String, String>>? = null) : ConvertibleToJava<CustomServiceArgs>

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern. In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible To get more information about Service, see:

Link copied to clipboard
Link copied to clipboard
object CustomServiceMapper : ResourceMapper<CustomService>
Link copied to clipboard
Link copied to clipboard
class Dashboard : KotlinCustomResource

A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application. To get more information about Dashboards, see:

Link copied to clipboard
data class DashboardArgs(val dashboardJson: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<DashboardArgs>

A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application. To get more information about Dashboards, see:

Link copied to clipboard
Link copied to clipboard
object DashboardMapper : ResourceMapper<Dashboard>
Link copied to clipboard
Link copied to clipboard
class GenericService : KotlinCustomResource

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern. In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible To get more information about GenericService, see:

Link copied to clipboard
data class GenericServiceArgs(val basicService: Output<GenericServiceBasicServiceArgs>? = null, val displayName: Output<String>? = null, val project: Output<String>? = null, val serviceId: Output<String>? = null, val userLabels: Output<Map<String, String>>? = null) : ConvertibleToJava<GenericServiceArgs>

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern. In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible To get more information about GenericService, see:

Link copied to clipboard
Link copied to clipboard
object GenericServiceMapper : ResourceMapper<GenericService>
Link copied to clipboard
class Group : KotlinCustomResource

The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. To get more information about Group, see:

Link copied to clipboard
data class GroupArgs(val displayName: Output<String>? = null, val filter: Output<String>? = null, val isCluster: Output<Boolean>? = null, val parentName: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<GroupArgs>

The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. To get more information about Group, see:

Link copied to clipboard

Builder for GroupArgs.

Link copied to clipboard
object GroupMapper : ResourceMapper<Group>
Link copied to clipboard

Builder for Group.

Link copied to clipboard
class MetricDescriptor : KotlinCustomResource

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:

Link copied to clipboard
data class MetricDescriptorArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val labels: Output<List<MetricDescriptorLabelArgs>>? = null, val launchStage: Output<String>? = null, val metadata: Output<MetricDescriptorMetadataArgs>? = null, val metricKind: Output<String>? = null, val project: Output<String>? = null, val type: Output<String>? = null, val unit: Output<String>? = null, val valueType: Output<String>? = null) : ConvertibleToJava<MetricDescriptorArgs>

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:

Link copied to clipboard
object MetricDescriptorMapper : ResourceMapper<MetricDescriptor>
Link copied to clipboard
class MonitoredProject : KotlinCustomResource

A project being monitored by a Metrics Scope. To get more information about MonitoredProject, see:

Link copied to clipboard
data class MonitoredProjectArgs(val metricsScope: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<MonitoredProjectArgs>

A project being monitored by a Metrics Scope. To get more information about MonitoredProject, see:

Link copied to clipboard
object MonitoredProjectMapper : ResourceMapper<MonitoredProject>
Link copied to clipboard
Link copied to clipboard
class NotificationChannel : KotlinCustomResource

A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval. Notification Channels are designed to be flexible and are made up of a supported type and labels to configure that channel. Each type has specific labels that need to be present for that channel to be correctly configured. The labels that are required to be present for one channel type are often different than those required for another. Due to these loose constraints it's often best to set up a channel through the UI and import it to the provider when setting up a brand new channel type to determine which labels are required. A list of supported channels per project the list endpoint can be accessed programmatically or through the api explorer at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannelDescriptors/list . This provides the channel type and all of the required labels that must be passed. To get more information about NotificationChannel, see:

Link copied to clipboard
data class NotificationChannelArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val enabled: Output<Boolean>? = null, val forceDelete: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val project: Output<String>? = null, val sensitiveLabels: Output<NotificationChannelSensitiveLabelsArgs>? = null, val type: Output<String>? = null, val userLabels: Output<Map<String, String>>? = null) : ConvertibleToJava<NotificationChannelArgs>

A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval. Notification Channels are designed to be flexible and are made up of a supported type and labels to configure that channel. Each type has specific labels that need to be present for that channel to be correctly configured. The labels that are required to be present for one channel type are often different than those required for another. Due to these loose constraints it's often best to set up a channel through the UI and import it to the provider when setting up a brand new channel type to determine which labels are required. A list of supported channels per project the list endpoint can be accessed programmatically or through the api explorer at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannelDescriptors/list . This provides the channel type and all of the required labels that must be passed. To get more information about NotificationChannel, see:

Link copied to clipboard
Link copied to clipboard
class Slo : KotlinCustomResource

A Service-Level Objective (SLO) describes the level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully." To get more information about Slo, see:

Link copied to clipboard
data class SloArgs(val basicSli: Output<SloBasicSliArgs>? = null, val calendarPeriod: Output<String>? = null, val displayName: Output<String>? = null, val goal: Output<Double>? = null, val project: Output<String>? = null, val requestBasedSli: Output<SloRequestBasedSliArgs>? = null, val rollingPeriodDays: Output<Int>? = null, val service: Output<String>? = null, val sloId: Output<String>? = null, val userLabels: Output<Map<String, String>>? = null, val windowsBasedSli: Output<SloWindowsBasedSliArgs>? = null) : ConvertibleToJava<SloArgs>

A Service-Level Objective (SLO) describes the level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully." To get more information about Slo, see:

Link copied to clipboard

Builder for SloArgs.

Link copied to clipboard
object SloMapper : ResourceMapper<Slo>
Link copied to clipboard

Builder for Slo.

Link copied to clipboard
class UptimeCheckConfig : KotlinCustomResource

This message configures which resources and services to monitor for availability. To get more information about UptimeCheckConfig, see:

Link copied to clipboard
data class UptimeCheckConfigArgs(val checkerType: Output<String>? = null, val contentMatchers: Output<List<UptimeCheckConfigContentMatcherArgs>>? = null, val displayName: Output<String>? = null, val httpCheck: Output<UptimeCheckConfigHttpCheckArgs>? = null, val logCheckFailures: Output<Boolean>? = null, val monitoredResource: Output<UptimeCheckConfigMonitoredResourceArgs>? = null, val period: Output<String>? = null, val project: Output<String>? = null, val resourceGroup: Output<UptimeCheckConfigResourceGroupArgs>? = null, val selectedRegions: Output<List<String>>? = null, val syntheticMonitor: Output<UptimeCheckConfigSyntheticMonitorArgs>? = null, val tcpCheck: Output<UptimeCheckConfigTcpCheckArgs>? = null, val timeout: Output<String>? = null, val userLabels: Output<Map<String, String>>? = null) : ConvertibleToJava<UptimeCheckConfigArgs>

This message configures which resources and services to monitor for availability. To get more information about UptimeCheckConfig, see:

Link copied to clipboard
object UptimeCheckConfigMapper : ResourceMapper<UptimeCheckConfig>

Functions

Link copied to clipboard
suspend fun alertPolicy(name: String, block: suspend AlertPolicyResourceBuilder.() -> Unit): AlertPolicy
Link copied to clipboard
Link copied to clipboard
suspend fun dashboard(name: String, block: suspend DashboardResourceBuilder.() -> Unit): Dashboard
Link copied to clipboard
Link copied to clipboard
fun group(name: String): Group
suspend fun group(name: String, block: suspend GroupResourceBuilder.() -> Unit): Group
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun slo(name: String): Slo
suspend fun slo(name: String, block: suspend SloResourceBuilder.() -> Unit): Slo