com.google.api.services.servicemanagement.model

Class MonitoredResourceDescriptor

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.servicemanagement.model.MonitoredResourceDescriptor

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class MonitoredResourceDescriptor
extends com.google.api.client.json.GenericJson

An object that describes the schema of a MonitoredResource object using 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. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Service Management API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MonitoredResourceDescriptor()

Method Summary

Modifier and Type	Method and Description
MonitoredResourceDescriptor	clone()
String	getDescription() Optional.
String	getDisplayName() Optional.
List<LabelDescriptor>	getLabels() Required.
String	getLaunchStage() Optional.
String	getName() Optional.
String	getType() Required.
MonitoredResourceDescriptor	set(String fieldName, Object value)
MonitoredResourceDescriptor	setDescription(String description) Optional.
MonitoredResourceDescriptor	setDisplayName(String displayName) Optional.
MonitoredResourceDescriptor	setLabels(List<LabelDescriptor> labels) Required.
MonitoredResourceDescriptor	setLaunchStage(String launchStage) Optional.
MonitoredResourceDescriptor	setName(String name) Optional.
MonitoredResourceDescriptor	setType(String type) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

MonitoredResourceDescriptor

public MonitoredResourceDescriptor()

Method Detail

getDescription

public String getDescription()

Optional. A detailed description of the monitored resource type that might be used in documentation.

Returns:

value or null for none

setDescription

public MonitoredResourceDescriptor setDescription(String description)

Optional. A detailed description of the monitored resource type that might be used in documentation.

Parameters:

description - description or null for none

getDisplayName

public String getDisplayName()

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.

Returns:

value or null for none

setDisplayName

public MonitoredResourceDescriptor setDisplayName(String displayName)

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.

Parameters:

displayName - displayName or null for none

getLabels

public List<LabelDescriptor> getLabels()

Required. A set 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 `"zone"`.

Returns:

value or null for none

setLabels

public MonitoredResourceDescriptor setLabels(List<LabelDescriptor> labels)

Required. A set 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 `"zone"`.

Parameters:

labels - labels or null for none

getLaunchStage

public String getLaunchStage()

Optional. The launch stage of the monitored resource definition.

Returns:

value or null for none

setLaunchStage

public MonitoredResourceDescriptor setLaunchStage(String launchStage)

Optional. The launch stage of the monitored resource definition.

Parameters:

launchStage - launchStage or null for none

getName

public String getName()

Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.

Returns:

value or null for none

setName

public MonitoredResourceDescriptor setName(String name)

Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.

Parameters:

name - name or null for none

getType

public String getType()

Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitored resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).

Returns:

value or null for none

setType

public MonitoredResourceDescriptor setType(String type)

Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitored resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).

Parameters:

type - type or null for none

set

public MonitoredResourceDescriptor set(String fieldName,
                                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public MonitoredResourceDescriptor clone()

Overrides:

clone in class com.google.api.client.json.GenericJson