Class Metric.Builder (3.9.0)

public static final class Metric.Builder extends MetricInfo.Builder

A builder for Metric objects.

Inheritance

java.lang.Object > MetricInfo.Builder > Metric.Builder

Inherited Members

MetricInfo.Builder.build()

MetricInfo.Builder.setDescription(String)

MetricInfo.Builder.setFilter(String)

MetricInfo.Builder.setName(String)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public Metric build()

Creates a MetricInfo object for this builder.

Returns

Type	Description
Metric

Overrides

MetricInfo.Builder.build()

setDescription(String description)

public Metric.Builder setDescription(String description)

Sets an optional description for this metric. Used for documentation purpose.

Parameter

Name	Description
description	`String`

Returns

Type	Description
Metric.Builder

Overrides

MetricInfo.Builder.setDescription(String description)

setFilter(String filter)

public Metric.Builder setFilter(String filter)

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.

Parameter

Name	Description
filter	`String`

Returns

Type	Description
Metric.Builder

Overrides

MetricInfo.Builder.setFilter(String filter)

setName(String name)

public Metric.Builder setName(String name)

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 _-.,+!*',()%/</code>. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.

Parameter

Name	Description
name	`String`

Returns

Type	Description
Metric.Builder

Overrides

MetricInfo.Builder.setName(String name)