Class: Google::Apis::ServiceusageV1::MonitoredResourceDescriptor

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MonitoredResourceDescriptor

Returns a new instance of MonitoredResourceDescriptor.



2794
2795
2796
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2794

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

Returns:

  • (String) 


2757
2758
2759
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2757

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

Returns:

  • (String) 


2764
2765
2766
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2764

def display_name
  @display_name
end

#labels ⇒ Array<Google::Apis::ServiceusageV1::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

Returns:



2771
2772
2773
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2771

def labels
  @labels
end

#launch_stage ⇒ String

Optional. The launch stage of the monitored resource definition. Corresponds to the JSON property launchStage

Returns:

  • (String) 


2776
2777
2778
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2776

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

Returns:

  • (String) 


2786
2787
2788
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2786

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

Returns:

  • (String) 


2792
2793
2794
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2792

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2799
2800
2801
2802
2803
2804
2805
2806
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2799

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