Package com.google.cloud.logging

Class MetricInfo

java.lang.Object

com.google.cloud.logging.MetricInfo

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Metric

public class MetricInfo
extends Object
implements Serializable

Cloud Logging metrics describe logs-based metric. The value of the metric is the number of log entries that match a logs filter (see getFilter()).

See Also:

Logs-based Metrics , Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricInfo.Builder	A builder for MetricInfo objects.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()	Returns an optional description for this metric.
String	getFilter()	Returns an advanced logs filter.
String	getName()	Returns the name of the metric.
int	hashCode()
static MetricInfo.Builder	newBuilder(String name, String filter)	Returns a builder for MetricInfo objects given the name of the metric and its filter.
static MetricInfo	of(String name, String filter)	Creates a MetricInfo object given the name of the metric and its filter.
MetricInfo.Builder	toBuilder()	Returns a builder for this MetricInfo object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Returns 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.

getDescription

public String getDescription()

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

getFilter

public String getFilter()

Returns 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.

See Also:

Advanced Log Filters

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public MetricInfo.Builder toBuilder()

Returns a builder for this MetricInfo object.

newBuilder

public static MetricInfo.Builder newBuilder(String name,
                                            String filter)

Returns a builder for MetricInfo objects given the name of the metric and its filter.

of

public static MetricInfo of(String name,
                            String filter)

Creates a MetricInfo object given the name of the metric and its filter.