monitoredres

Documentation

Overview

Package monitoredres is a generated protocol buffer package.

It is generated from these files:

google/api/monitored_resource.proto

It has these top-level messages:

MonitoredResourceDescriptor
MonitoredResource

Index

• type MonitoredResource
  • func (*MonitoredResource) Descriptor() ([]byte, []int)
  • func (m *MonitoredResource) GetLabels() map[string]string
  • func (m *MonitoredResource) GetType() string
  • func (*MonitoredResource) ProtoMessage()
  • func (m *MonitoredResource) Reset()
  • func (m *MonitoredResource) String() string
• type MonitoredResourceDescriptor
  • func (*MonitoredResourceDescriptor) Descriptor() ([]byte, []int)
  • func (m *MonitoredResourceDescriptor) GetDescription() string
  • func (m *MonitoredResourceDescriptor) GetDisplayName() string
  • func (m *MonitoredResourceDescriptor) GetLabels() []*google_api.LabelDescriptor
  • func (m *MonitoredResourceDescriptor) GetName() string
  • func (m *MonitoredResourceDescriptor) GetType() string
  • func (*MonitoredResourceDescriptor) ProtoMessage()
  • func (m *MonitoredResourceDescriptor) Reset()
  • func (m *MonitoredResourceDescriptor) String() string

Types

type MonitoredResource

type MonitoredResource struct {
	// Required. The monitored resource type. This field must match
	// the `type` field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For
	// example, the type of a Cloud SQL database is `"cloudsql_database"`.
	Type string `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	// Required. Values for all of the labels listed in the associated monitored
	// resource descriptor. For example, Cloud SQL databases use the labels
	// `"database_id"` and `"zone"`.
	Labels map[string]string `` /* 132-byte string literal not displayed */
}

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[google.api.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[google.api.MonitoredResourceDescriptor] for `"gce_instance"` has labels `"instance_id"` and `"zone"`:

{ "type": "gce_instance",
  "labels": { "instance_id": "12345678901234",
              "zone": "us-central1-a" }}

func (*MonitoredResource) Descriptor

func (*MonitoredResource) Descriptor() ([]byte, []int)

func (*MonitoredResource) GetLabels

func (m *MonitoredResource) GetLabels() map[string]string

func (*MonitoredResource) GetType

func (m *MonitoredResource) GetType() string

func (*MonitoredResource) ProtoMessage

func (*MonitoredResource) ProtoMessage()

func (*MonitoredResource) Reset

func (m *MonitoredResource) Reset()

func (*MonitoredResource) String

func (m *MonitoredResource) String() string

type MonitoredResourceDescriptor

type MonitoredResourceDescriptor struct {
	// 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}"`.
	Name string `protobuf:"bytes,5,opt,name=name" json:"name,omitempty"`
	// 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.
	Type string `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	// 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"`.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// Optional. A detailed description of the monitored resource type that might
	// be used in documentation.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// 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"`.
	Labels []*google_api.LabelDescriptor `protobuf:"bytes,4,rep,name=labels" json:"labels,omitempty"`
}

An object that describes the schema of a MonitoredResource[google.api.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.

func (*MonitoredResourceDescriptor) Descriptor

func (*MonitoredResourceDescriptor) Descriptor() ([]byte, []int)

func (*MonitoredResourceDescriptor) GetDescription

func (m *MonitoredResourceDescriptor) GetDescription() string

func (*MonitoredResourceDescriptor) GetDisplayName

func (m *MonitoredResourceDescriptor) GetDisplayName() string

func (*MonitoredResourceDescriptor) GetLabels

func (m *MonitoredResourceDescriptor) GetLabels() []*google_api.LabelDescriptor

func (*MonitoredResourceDescriptor) GetName

func (m *MonitoredResourceDescriptor) GetName() string

func (*MonitoredResourceDescriptor) GetType

func (m *MonitoredResourceDescriptor) GetType() string

func (*MonitoredResourceDescriptor) ProtoMessage

func (*MonitoredResourceDescriptor) ProtoMessage()

func (*MonitoredResourceDescriptor) Reset

func (m *MonitoredResourceDescriptor) Reset()

func (*MonitoredResourceDescriptor) String

func (m *MonitoredResourceDescriptor) String() string