Package 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 ofgce_instance
and specifies the use of the labelsinstance_id
andzone
to identify particular VM instances.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MonitoredResourceDescriptor.LabelDescriptor
This class describes a label for a monitored resource.
-
Field Summary
Fields Modifier and Type Field Description static com.google.api.core.ApiFunction<com.google.api.MonitoredResourceDescriptor,MonitoredResourceDescriptor>
FROM_PB_FUNCTION
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
static MonitoredResourceDescriptor
fromPb(com.google.api.MonitoredResourceDescriptor descriptorPb)
String
getDescription()
Returns an optional detailed description of the monitored resource type.String
getDisplayName()
Returns an optional concise name for the monitored resource type.List<MonitoredResourceDescriptor.LabelDescriptor>
getLabels()
Returns a list of labels used to describe instances of this monitored resource type.String
getName()
Returns an optional name for the monitored resource descriptor.String
getType()
Returns the monitored resource type.int
hashCode()
com.google.api.MonitoredResourceDescriptor
toPb()
String
toString()
-
-
-
Field Detail
-
FROM_PB_FUNCTION
public static final com.google.api.core.ApiFunction<com.google.api.MonitoredResourceDescriptor,MonitoredResourceDescriptor> FROM_PB_FUNCTION
-
-
Method Detail
-
getType
public String getType()
Returns the monitored resource type. For example, the typecloudsql_database
represents databases in Google Cloud SQL.
-
getName
public String getName()
Returns an optional name for the monitored resource descriptor. If not set, this method returnsnull
.
-
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 returnsnull
.
-
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 returnsnull
.
-
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 labelsdatabase_id
andregion
.
-
toPb
public com.google.api.MonitoredResourceDescriptor toPb()
-
fromPb
public static MonitoredResourceDescriptor fromPb(com.google.api.MonitoredResourceDescriptor descriptorPb)
-
-