com.google.cloud

Class MonitoredResourceDescriptor

java.lang.Object

com.google.cloud.MonitoredResourceDescriptor

All Implemented Interfaces:

Serializable

public class MonitoredResourceDescriptor
extends Object
implements Serializable

This class describes the schema of Cloud monitored resources. Monitored resource descriptors contain a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of gce_instance and specifies the use of the labels instance_id and zone to identify particular VM instances.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitoredResourceDescriptor.LabelDescriptor This class describes a label for a monitored resource.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<com.google.api.MonitoredResourceDescriptor,MonitoredResourceDescriptor>	FROM_PB_FUNCTION

Method Summary

Methods

Modifier and Type	Method and Description
String	description() Returns an optional detailed description of the monitored resource type.
String	displayName() Returns an optional concise name for the monitored resource type.
boolean	equals(Object obj)
static MonitoredResourceDescriptor	fromPb(com.google.api.MonitoredResourceDescriptor descriptorPb)
int	hashCode()
List<MonitoredResourceDescriptor.LabelDescriptor>	labels() Returns a list of labels used to describe instances of this monitored resource type.
String	name() Returns an optional name for the monitored resource descriptor.
com.google.api.MonitoredResourceDescriptor	toPb()
String	toString()
String	type() Returns the monitored resource type.

Methods inherited from class java.lang.Object

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

Field Detail

FROM_PB_FUNCTION

public static final com.google.common.base.Function<com.google.api.MonitoredResourceDescriptor,MonitoredResourceDescriptor> FROM_PB_FUNCTION

Method Detail

type

public String type()

Returns the monitored resource type. For example, the type cloudsql_database represents databases in Google Cloud SQL.

name

public String name()

Returns an optional name for the monitored resource descriptor. If not set, this method returns null.

displayName

public String displayName()

Returns an optional concise name for the monitored resource type. This value might be displayed in user interfaces. For example, Google Cloud SQL Database. If not set, this method returns null.

description

public String description()

Returns an optional detailed description of the monitored resource type. This value might be used in documentation. If not set, this method returns null.

labels

public List<MonitoredResourceDescriptor.LabelDescriptor> labels()

Returns a list of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels database_id and region.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toPb

public com.google.api.MonitoredResourceDescriptor toPb()

fromPb

public static MonitoredResourceDescriptor fromPb(com.google.api.MonitoredResourceDescriptor descriptorPb)