Package com.google.cloud.logging

Class Metric.Builder

java.lang.Object
com.google.cloud.logging.MetricInfo.Builder
com.google.cloud.logging.Metric.Builder
Enclosing class:
Metric
public static final class Metric.Builder extends MetricInfo.Builder
A builder for Metric objects.

  • Method Details

    • setName

      @CanIgnoreReturnValue public Metric.Builder setName(String name)
      Description copied from class: MetricInfo.Builder
      Sets the name of the metric. Example: severe-errors. Metric identifiers are limited to 1000 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.
      Specified by:
      setName in class MetricInfo.Builder

    • setDescription

      @CanIgnoreReturnValue public Metric.Builder setDescription(String description)
      Description copied from class: MetricInfo.Builder
      Sets an optional description for this metric. Used for documentation purpose.
      Specified by:
      setDescription in class MetricInfo.Builder

    • setFilter

      @CanIgnoreReturnValue public Metric.Builder setFilter(String filter)
      Description copied from class: MetricInfo.Builder
      Sets an advanced logs filter. The value of the metric is the number of log entries that match this filter. Example: logName=projects/my-projectid/logs/syslog AND severity>=ERROR.
      Specified by:
      setFilter in class MetricInfo.Builder
      See Also:

    • build

      public Metric build()
      Description copied from class: MetricInfo.Builder
      Creates a MetricInfo object for this builder.
      Specified by:
      build in class MetricInfo.Builder