MetricArgs class

The set of arguments for Metric. The set of arguments for Metric.

Constructors

MetricArgs({Input<String?>? bucketName, Input<MetricBucketOptions?>? bucketOptions, Input<String?>? deletionPolicy, Input<String?>? description, Input<bool?>? disabled, required Input<String> filter, Input<Map<String, String>?>? labelExtractors, Input<MetricMetricDescriptor?>? metricDescriptor, Input<String?>? name, Input<String?>? project, Input<String?>? valueExtractor})
Creates a new MetricArgs. bucketName The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects bucketOptions The bucketOptions are required when the logs-based metric is using a DISTRIBUTION value type and it deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description A description of this metric, which is used in documentation. The maximum length of the disabled If set to True, then this metric is disabled and it does not generate any points. filter An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-filters) which labelExtractors A map from a label key string to an extractor expression which is used to extract data from a log metricDescriptor The optional metric descriptor associated with the logs-based metric. name The client-assigned metric identifier. Examples - "errorCount", "nginx/requests". project The ID of the project in which the resource belongs. valueExtractor A valueExtractor is required when using a distribution logs-based metric to extract the values to
const
MetricArgs.fromMap(Map<String, dynamic> map)
factory

Properties

bucketName → Input<String?>?
The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.
final
bucketOptions → Input<MetricBucketOptions?>?
The bucketOptions are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values. Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
final
disabled → Input<bool?>?
If set to True, then this metric is disabled and it does not generate any points.
final
filter → Input<String>
An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-filters) which is used to match log entries.
final
hashCode → int
The hash code for this object.
no setterinherited
labelExtractors → Input<Map<String, String>?>?
A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the valueExtractor field.
final
metricDescriptor → Input<MetricMetricDescriptor?>?
The optional metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression. Structure is documented below.
final
name → Input<String?>?
The client-assigned metric identifier. Examples - "errorCount", "nginx/requests". Metric identifiers are limited to 100 characters and can include only the following characters A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
valueExtractor → Input<String?>?
A valueExtractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction - EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are 1. field - The name of the log entry field from which the value is to be extracted. 2. regex - A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited