Class: Google::Apis::ServiceusageV1beta1::MonitoredResourceDescriptor
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1beta1::MonitoredResourceDescriptor
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceusage_v1beta1/classes.rb,
generated/google/apis/serviceusage_v1beta1/representations.rb,
generated/google/apis/serviceusage_v1beta1/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::ServiceusageV1beta1::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
2690 2691 2692 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2690 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
2656 2657 2658 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2656 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
2664 2665 2666 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2664 def display_name @display_name end |
#labels ⇒ Array<Google::Apis::ServiceusageV1beta1::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
2671 2672 2673 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2671 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
2681 2682 2683 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2681 def name @name end |
#type ⇒ String
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.
Corresponds to the JSON property type
2688 2689 2690 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2688 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2695 2696 2697 2698 2699 2700 2701 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2695 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) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) end |