Class: Google::Apis::MonitoringV3::MonitoredResourceDescriptor
- Inherits:
-
Object
- Object
- Google::Apis::MonitoringV3::MonitoredResourceDescriptor
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/google/apis/monitoring_v3/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#description ⇒ String
Optional.
-
#display_name ⇒ String
Optional.
-
#labels ⇒ Array<Google::Apis::MonitoringV3::LabelDescriptor>
Required.
-
#launch_stage ⇒ String
Optional.
-
#name ⇒ String
Optional.
-
#type ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MonitoredResourceDescriptor
constructor
A new instance of MonitoredResourceDescriptor.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ MonitoredResourceDescriptor
Returns a new instance of MonitoredResourceDescriptor.
3351 3352 3353 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3351 def initialize(**args) update!(**args) end |
Instance Attribute Details
#description ⇒ String
Optional. A detailed description of the monitored resource type that might be
used in documentation.
Corresponds to the JSON property description
3311 3312 3313 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3311 def description @description end |
#display_name ⇒ String
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".
Corresponds to the JSON property displayName
3318 3319 3320 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3318 def display_name @display_name end |
#labels ⇒ Array<Google::Apis::MonitoringV3::LabelDescriptor>
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".
Corresponds to the JSON property labels
3325 3326 3327 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3325 def labels @labels end |
#launch_stage ⇒ String
Optional. The launch stage of the monitored resource definition.
Corresponds to the JSON property launchStage
3330 3331 3332 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3330 def launch_stage @launch_stage end |
#name ⇒ String
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
".
Corresponds to the JSON property name
3340 3341 3342 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3340 def name @name end |
#type ⇒ String
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).
Corresponds to the JSON property type
3349 3350 3351 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3349 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3356 3357 3358 3359 3360 3361 3362 3363 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3356 def update!(**args) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @labels = args[:labels] if args.key?(:labels) @launch_stage = args[:launch_stage] if args.key?(:launch_stage) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) end |