// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Note: this file is purely for documentation. Any contents are not expected
// to be loaded as the JS file.
/**
* 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.
*
* @property {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}"`.
*
* @property {string} type
* Required. The monitored resource type. For example, the type
* `"cloudsql_database"` represents databases in Google Cloud SQL.
* The maximum length of this value is 256 characters.
*
* @property {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"`.
*
* @property {string} description
* Optional. A detailed description of the monitored resource type that might
* be used in documentation.
*
* @property {Object[]} 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"`.
*
* This object should have the same structure as [LabelDescriptor]{@link google.api.LabelDescriptor}
*
* @property {number} launchStage
* Optional. The launch stage of the monitored resource definition.
*
* The number should be among the values of [LaunchStage]{@link google.api.LaunchStage}
*
* @typedef MonitoredResourceDescriptor
* @memberof google.api
* @see [google.api.MonitoredResourceDescriptor definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/api/monitored_resource.proto}
*/
const MonitoredResourceDescriptor = {
// This is for documentation. Actual contents will be loaded by gRPC.
};
/**
* 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 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 for `"gce_instance"` has labels
* `"instance_id"` and `"zone"`:
*
* { "type": "gce_instance",
* "labels": { "instance_id": "12345678901234",
* "zone": "us-central1-a" }}
*
* @property {string} type
* Required. The monitored resource type. This field must match
* the `type` field of a MonitoredResourceDescriptor object. For
* example, the type of a Compute Engine VM instance is `gce_instance`.
*
* @property {Object.<string, string>} 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"`.
*
* @typedef MonitoredResource
* @memberof google.api
* @see [google.api.MonitoredResource definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/api/monitored_resource.proto}
*/
const MonitoredResource = {
// This is for documentation. Actual contents will be loaded by gRPC.
};
/**
* Auxiliary metadata for a MonitoredResource object.
* 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.
*
* @property {Object} 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 }
*
* This object should have the same structure as [Struct]{@link google.protobuf.Struct}
*
* @property {Object.<string, string>} userLabels
* Output only. A map of user-defined metadata labels.
*
* @typedef MonitoredResourceMetadata
* @memberof google.api
* @see [google.api.MonitoredResourceMetadata definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/api/monitored_resource.proto}
*/
const MonitoredResourceMetadata = {
// This is for documentation. Actual contents will be loaded by gRPC.
};