monitoredres

Documentation

Index

• Variables
• type MonitoredResource
  • func (*MonitoredResource) Descriptor() ([]byte, []int)
  • func (x *MonitoredResource) GetLabels() map[string]string
  • func (x *MonitoredResource) GetType() string
  • func (*MonitoredResource) ProtoMessage()
  • func (x *MonitoredResource) ProtoReflect() protoreflect.Message
  • func (x *MonitoredResource) Reset()
  • func (x *MonitoredResource) String() string
• type MonitoredResourceDescriptor
  • func (*MonitoredResourceDescriptor) Descriptor() ([]byte, []int)
  • func (x *MonitoredResourceDescriptor) GetDescription() string
  • func (x *MonitoredResourceDescriptor) GetDisplayName() string
  • func (x *MonitoredResourceDescriptor) GetLabels() []*label.LabelDescriptor
  • func (x *MonitoredResourceDescriptor) GetLaunchStage() api.LaunchStage
  • func (x *MonitoredResourceDescriptor) GetName() string
  • func (x *MonitoredResourceDescriptor) GetType() string
  • func (*MonitoredResourceDescriptor) ProtoMessage()
  • func (x *MonitoredResourceDescriptor) ProtoReflect() protoreflect.Message
  • func (x *MonitoredResourceDescriptor) Reset()
  • func (x *MonitoredResourceDescriptor) String() string
• type MonitoredResourceMetadata
  • func (*MonitoredResourceMetadata) Descriptor() ([]byte, []int)
  • func (x *MonitoredResourceMetadata) GetSystemLabels() *structpb.Struct
  • func (x *MonitoredResourceMetadata) GetUserLabels() map[string]string
  • func (*MonitoredResourceMetadata) ProtoMessage()
  • func (x *MonitoredResourceMetadata) ProtoReflect() protoreflect.Message
  • func (x *MonitoredResourceMetadata) Reset()
  • func (x *MonitoredResourceMetadata) String() string

Variables

var File_google_api_monitored_resource_proto protoreflect.FileDescriptor

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 Compute Engine VM instance is `gce_instance`.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Required. Values for all of the labels listed in the associated monitored
	// resource descriptor. For example, Compute Engine VM instances use the
	// labels `"project_id"`, `"instance_id"`, and `"zone"`.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

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)

Deprecated: Use MonitoredResource.ProtoReflect.Descriptor instead.

func (*MonitoredResource) GetLabels

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

func (*MonitoredResource) GetType

func (x *MonitoredResource) GetType() string

func (*MonitoredResource) ProtoMessage

func (*MonitoredResource) ProtoMessage()

func (*MonitoredResource) ProtoReflect

func (x *MonitoredResource) ProtoReflect() protoreflect.Message

func (*MonitoredResource) Reset

func (x *MonitoredResource) Reset()

func (*MonitoredResource) String

func (x *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,proto3" json:"name,omitempty"`
	// Required. The monitored resource type. For example, the type
	// `"cloudsql_database"` represents databases in Google Cloud SQL.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" 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,proto3" 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,proto3" 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 []*label.LabelDescriptor `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty"`
	// Optional. The launch stage of the monitored resource definition.
	LaunchStage api.LaunchStage `protobuf:"varint,7,opt,name=launch_stage,json=launchStage,proto3,enum=google.api.LaunchStage" json:"launch_stage,omitempty"`
	// contains filtered or unexported fields
}

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)

Deprecated: Use MonitoredResourceDescriptor.ProtoReflect.Descriptor instead.

func (*MonitoredResourceDescriptor) GetDescription

func (x *MonitoredResourceDescriptor) GetDescription() string

func (*MonitoredResourceDescriptor) GetDisplayName

func (x *MonitoredResourceDescriptor) GetDisplayName() string

func (*MonitoredResourceDescriptor) GetLabels

func (x *MonitoredResourceDescriptor) GetLabels() []*label.LabelDescriptor

func (*MonitoredResourceDescriptor) GetLaunchStage

func (x *MonitoredResourceDescriptor) GetLaunchStage() api.LaunchStage

func (*MonitoredResourceDescriptor) GetName

func (x *MonitoredResourceDescriptor) GetName() string

func (*MonitoredResourceDescriptor) GetType

func (x *MonitoredResourceDescriptor) GetType() string

func (*MonitoredResourceDescriptor) ProtoMessage

func (*MonitoredResourceDescriptor) ProtoMessage()

func (*MonitoredResourceDescriptor) ProtoReflect

func (x *MonitoredResourceDescriptor) ProtoReflect() protoreflect.Message

func (*MonitoredResourceDescriptor) Reset

func (x *MonitoredResourceDescriptor) Reset()

func (*MonitoredResourceDescriptor) String

func (x *MonitoredResourceDescriptor) String() string

type MonitoredResourceMetadata

type MonitoredResourceMetadata struct {

	// Output only. Values for predefined system metadata labels.
	// System labels are a kind of metadata extracted by Google, including
	// "machine_image", "vpc", "subnet_id",
	// "security_group", "name", etc.
	// System label values can be only strings, Boolean values, or a list of
	// strings. For example:
	//
	//     { "name": "my-test-instance",
	//       "security_group": ["a", "b", "c"],
	//       "spot_instance": false }
	SystemLabels *structpb.Struct `protobuf:"bytes,1,opt,name=system_labels,json=systemLabels,proto3" json:"system_labels,omitempty"`
	// Output only. A map of user-defined metadata labels.
	UserLabels map[string]string `` /* 179-byte string literal not displayed */
	// contains filtered or unexported fields
}

Auxiliary metadata for a MonitoredResource[google.api.MonitoredResource] object. MonitoredResource[google.api.MonitoredResource] objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.

func (*MonitoredResourceMetadata) Descriptor

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

Deprecated: Use MonitoredResourceMetadata.ProtoReflect.Descriptor instead.

func (*MonitoredResourceMetadata) GetSystemLabels

func (x *MonitoredResourceMetadata) GetSystemLabels() *structpb.Struct

func (*MonitoredResourceMetadata) GetUserLabels

func (x *MonitoredResourceMetadata) GetUserLabels() map[string]string

func (*MonitoredResourceMetadata) ProtoMessage

func (*MonitoredResourceMetadata) ProtoMessage()

func (*MonitoredResourceMetadata) ProtoReflect

func (x *MonitoredResourceMetadata) ProtoReflect() protoreflect.Message

func (*MonitoredResourceMetadata) Reset

func (x *MonitoredResourceMetadata) Reset()

func (*MonitoredResourceMetadata) String

func (x *MonitoredResourceMetadata) String() string