Package com.hashicorp.cdktf.providers.google.logging_metric

Class LoggingMetricConfig.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • filter

        @Stability(Stable)
public LoggingMetricConfig.Builder filter​(String filter)
        Sets the value of LoggingMetricConfig.getFilter()
        Parameters:
        filter - An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-filters) which is used to match log entries. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#filter LoggingMetric#filter}
        Returns:
        this

      • name

        @Stability(Stable)
public LoggingMetricConfig.Builder name​(String name)
        Sets the value of LoggingMetricConfig.getName()
        Parameters:
        name - The client-assigned metric identifier. This parameter is required. Examples - "error_count", "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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#name LoggingMetric#name}
        Returns:
        this

      • bucketName

        @Stability(Stable)
public LoggingMetricConfig.Builder bucketName​(String bucketName)
        Sets the value of LoggingMetricConfig.getBucketName()
        Parameters:
        bucketName - 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#bucket_name LoggingMetric#bucket_name}
        Returns:
        this

      • description

        @Stability(Stable)
public LoggingMetricConfig.Builder description​(String description)
        Sets the value of LoggingMetricConfig.getDescription()
        Parameters:
        description - A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#description LoggingMetric#description}
        Returns:
        this

      • disabled

        @Stability(Stable)
public LoggingMetricConfig.Builder disabled​(Boolean disabled)
        Sets the value of LoggingMetricConfig.getDisabled()
        Parameters:
        disabled - If set to True, then this metric is disabled and it does not generate any points. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#disabled LoggingMetric#disabled}
        Returns:
        this

      • disabled

        @Stability(Stable)
public LoggingMetricConfig.Builder disabled​(com.hashicorp.cdktf.IResolvable disabled)
        Sets the value of LoggingMetricConfig.getDisabled()
        Parameters:
        disabled - If set to True, then this metric is disabled and it does not generate any points. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#disabled LoggingMetric#disabled}
        Returns:
        this

      • id

        @Stability(Stable)
public LoggingMetricConfig.Builder id​(String id)
        Sets the value of LoggingMetricConfig.getId()
        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#id LoggingMetric#id}. Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
        Returns:
        this

      • labelExtractors

        @Stability(Stable)
public LoggingMetricConfig.Builder labelExtractors​(Map<String,​String> labelExtractors)
        Sets the value of LoggingMetricConfig.getLabelExtractors()
        Parameters:
        labelExtractors - 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#label_extractors LoggingMetric#label_extractors}
        Returns:
        this

      • project

        @Stability(Stable)
public LoggingMetricConfig.Builder project​(String project)
        Sets the value of LoggingMetricConfig.getProject()
        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#project LoggingMetric#project}.
        Returns:
        this

      • valueExtractor

        @Stability(Stable)
public LoggingMetricConfig.Builder valueExtractor​(String valueExtractor)
        Sets the value of LoggingMetricConfig.getValueExtractor()
        Parameters:
        valueExtractor - 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/logging_metric#value_extractor LoggingMetric#value_extractor}
        Returns:
        this

      • connection

        @Stability(Experimental)
public LoggingMetricConfig.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • connection

        @Stability(Experimental)
public LoggingMetricConfig.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public LoggingMetricConfig.Builder count​(Number count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public LoggingMetricConfig.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public LoggingMetricConfig.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Sets the value of TerraformMetaArguments.getDependsOn()
        Parameters:
        dependsOn - the value to be set.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public LoggingMetricConfig.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Sets the value of TerraformMetaArguments.getForEach()
        Parameters:
        forEach - the value to be set.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public LoggingMetricConfig.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Sets the value of TerraformMetaArguments.getLifecycle()
        Parameters:
        lifecycle - the value to be set.
        Returns:
        this

      • provider

        @Stability(Experimental)
public LoggingMetricConfig.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Sets the value of TerraformMetaArguments.getProvider()
        Parameters:
        provider - the value to be set.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public LoggingMetricConfig.Builder provisioners​(List<? extends Object> provisioners)
        Sets the value of TerraformMetaArguments.getProvisioners()
        Parameters:
        provisioners - the value to be set.
        Returns:
        this