Class MonitoredResourceDescriptor (2.47.0)

public class MonitoredResourceDescriptor 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.

Inheritance

Object > MonitoredResourceDescriptor

Implements

Serializable

Static Fields

FROM_PB_FUNCTION

public static final ApiFunction<MonitoredResourceDescriptor,MonitoredResourceDescriptor> FROM_PB_FUNCTION
Field Value
Type Description
ApiFunction<com.google.api.MonitoredResourceDescriptor,MonitoredResourceDescriptor>

Static Methods

fromPb(MonitoredResourceDescriptor descriptorPb)

public static MonitoredResourceDescriptor fromPb(MonitoredResourceDescriptor descriptorPb)
Parameter
Name Description
descriptorPb com.google.api.MonitoredResourceDescriptor
Returns
Type Description
MonitoredResourceDescriptor

Methods

equals(Object obj)

public final boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDescription()

public String getDescription()

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

Returns
Type Description
String

getDisplayName()

public String getDisplayName()

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.

Returns
Type Description
String

getLabels()

public List<MonitoredResourceDescriptor.LabelDescriptor> getLabels()

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.

Returns
Type Description
List<LabelDescriptor>

getName()

public String getName()

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

Returns
Type Description
String

getType()

public String getType()

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

Returns
Type Description
String

hashCode()

public final int hashCode()
Returns
Type Description
int
Overrides

toPb()

public MonitoredResourceDescriptor toPb()
Returns
Type Description
com.google.api.MonitoredResourceDescriptor

toString()

public String toString()
Returns
Type Description
String
Overrides