Class: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor
- Inherits:
-
Object
- Object
- Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/logging_v2beta1/classes.rb,
generated/google/apis/logging_v2beta1/representations.rb,
generated/google/apis/logging_v2beta1/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::LoggingV2beta1::LabelDescriptor>
Required.
-
#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.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ MonitoredResourceDescriptor
Returns a new instance of MonitoredResourceDescriptor.
636 637 638 |
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 636 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
627 628 629 |
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 627 def description @description end |
#display_name ⇒ String
Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. For example, "Google Cloud SQL Database"
.
Corresponds to the JSON property displayName
621 622 623 |
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 621 def display_name @display_name end |
#labels ⇒ Array<Google::Apis::LoggingV2beta1::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
634 635 636 |
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 634 def labels @labels 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
609 610 611 |
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 609 def name @name end |
#type ⇒ String
Required. The monitored resource type. For example, the type "
cloudsql_database"
represents databases in Google Cloud SQL.
Corresponds to the JSON property type
615 616 617 |
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 615 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
641 642 643 644 645 646 647 |
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 641 def update!(**args) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) @display_name = args[:display_name] if args.key?(:display_name) @description = args[:description] if args.key?(:description) @labels = args[:labels] if args.key?(:labels) end |