proto-google-common-protos-scalapb_0.11/com.google.api.monitored_resource

com.google.api.monitored_resource

package com.google.api.monitored_resource

Type members

Classlikes

@SerialVersionUID(0L)
final case
class MonitoredResource(`type`: String, labels: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MonitoredResource]

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for "gce_instance" has labels "instance_id" and "zone":

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for "gce_instance" has labels "instance_id" and "zone":

{ "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }}

Value Params
labels

Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".

type

Required. The monitored resource type. This field must match the type field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Compute Engine VM instance is gce_instance.

Companion
object
object MonitoredResource extends GeneratedMessageCompanion[MonitoredResource] with JavaProtoSupport[MonitoredResource, MonitoredResource]
Companion
class
@SerialVersionUID(0L)
final case
class MonitoredResourceDescriptor(name: String, `type`: String, displayName: String, description: String, labels: Seq[LabelDescriptor], launchStage: LaunchStage, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MonitoredResourceDescriptor]

An object that describes the schema of a [MonitoredResource][google.api.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.

An object that describes the schema of a [MonitoredResource][google.api.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.

Value Params
description

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

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

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

launchStage

Optional. The launch stage of the monitored resource definition.

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}".

type

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL.

Companion
object
object MonitoredResourceDescriptor extends GeneratedMessageCompanion[MonitoredResourceDescriptor] with JavaProtoSupport[MonitoredResourceDescriptor, MonitoredResourceDescriptor]
Companion
class
@SerialVersionUID(0L)
final case
class MonitoredResourceMetadata(systemLabels: Option[Struct], userLabels: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MonitoredResourceMetadata]

Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object. [MonitoredResource][google.api.MonitoredResource] objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.

Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object. [MonitoredResource][google.api.MonitoredResource] objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.

Value Params
systemLabels

Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false }

userLabels

Output only. A map of user-defined metadata labels.

Companion
object
object MonitoredResourceMetadata extends GeneratedMessageCompanion[MonitoredResourceMetadata] with JavaProtoSupport[MonitoredResourceMetadata, MonitoredResourceMetadata]
Companion
class
object MonitoredResourceProto extends GeneratedFileObject