Index
LabelDescriptor
(message)LabelDescriptor.ValueType
(enum)LaunchStage
(enum)MonitoredResource
(message)MonitoredResourceDescriptor
(message)MonitoredResourceMetadata
(message)
LabelDescriptor
A description of a label.
Fields | |
---|---|
key |
The label key. |
value_type |
The type of data that can be assigned to the label. |
description |
A human-readable description for the label. |
ValueType
Value types that can be used as label values.
Enums | |
---|---|
STRING |
A variable-length string. This is the default. |
BOOL |
Boolean; true or false. |
INT64 |
A 64-bit signed integer. |
LaunchStage
The launch stage as defined by Trusted Cloud Platform Launch Stages(https://paris.devsitetest.how/terms/launch-stages).
Enums | |
---|---|
LAUNCH_STAGE_UNSPECIFIED |
Do not use this default value. |
UNIMPLEMENTED |
The feature is not yet implemented. Users can not use it. |
PRELAUNCH |
Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS |
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA |
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA |
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA |
GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED |
Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service(https://paris.devsitetest.how/terms/) and the Trusted Cloud Platform Subject to the Deprecation Policy(https://paris.devsitetest.how/terms/deprecation) documentation. |
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
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 "project_id"
, "instance_id"
and "zone"
:
{ "type": "gce_instance",
"labels": { "project_id": "my-project",
"instance_id": "12345678901234",
"zone": "us-central1-a" }}
Fields | |
---|---|
type |
Required. The monitored resource type. This field must match the |
labels |
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels |
MonitoredResourceDescriptor
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 Trusted Cloud 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.
Fields | |
---|---|
name |
Optional. The resource name of the monitored resource descriptor: |
type |
Required. The monitored resource type. For example, the type |
display_name |
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, |
description |
Optional. A detailed description of the monitored resource type that might be used in documentation. |
labels[] |
Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Trusted Cloud Cloud SQL database is identified by values for the labels |
launch_stage |
Optional. The launch stage of the monitored resource definition. |
MonitoredResourceMetadata
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.
Fields | |
---|---|
system_labels |
Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Trusted Cloud, 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:
|
user_labels |
Output only. A map of user-defined metadata labels. |