package monitoredres

Import Path
	google.golang.org/genproto/googleapis/api/monitoredres (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 8 packages

Involved Source Files

	      monitored_resource.pb.go
Package-Level Type Names (total 3, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type MonitoredResource (struct)
		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" }}

		Fields (total 5, in which 2 are exported)
			Labels map[string]string
				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"`.

			Type string
				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`.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use MonitoredResource.ProtoReflect.Descriptor instead.

			(*T) GetLabels() map[string]string
			(*T) GetType() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least 11, in which 7 are exported)
			func google.golang.org/genproto/googleapis/logging/v2.(*LogEntry).GetResource() *MonitoredResource
			func google.golang.org/genproto/googleapis/logging/v2.(*WriteLogEntriesRequest).GetResource() *MonitoredResource
			func google.golang.org/genproto/googleapis/monitoring/v3.(*ListGroupMembersResponse).GetMembers() []*MonitoredResource
			func google.golang.org/genproto/googleapis/monitoring/v3.(*TimeSeries).GetResource() *MonitoredResource
			func google.golang.org/genproto/googleapis/monitoring/v3.(*UptimeCheckConfig).GetMonitoredResource() *MonitoredResource
			func cloud.google.com/go/monitoring/apiv3.(*MonitoredResourceIterator).Next() (*MonitoredResource, error)
			func contrib.go.opencensus.io/exporter/stackdriver.DefaultMapResource(res *resource.Resource) *MonitoredResource
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			func cloud.google.com/go/logging.detectResource() *MonitoredResource
			func cloud.google.com/go/logging.globalResource(projectID string) *MonitoredResource
			func cloud.google.com/go/logging.monitoredResource(parent string) *MonitoredResource
			func contrib.go.opencensus.io/exporter/stackdriver.convertMonitoredResourceToPB(mr monitoredresource.Interface) *MonitoredResource
		As Inputs Of (at least 3, in which 1 are exported)
			func cloud.google.com/go/logging.CommonResource(r *MonitoredResource) logging.LoggerOption
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func contrib.go.opencensus.io/exporter/stackdriver.copyMonitoredResourceAttributes(out *tracepb.Span_Attributes, mr *MonitoredResource) *tracepb.Span_Attributes
			func contrib.go.opencensus.io/exporter/stackdriver.protoFromSpanData(s *trace.SpanData, projectID string, mr *MonitoredResource, userAgent string) *tracepb.Span

	 type MonitoredResourceDescriptor (struct)
		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 services can support different monitored resource types.

		The following are specific rules to service defined monitored resources for
		Monitoring and Logging:

		* The `type`, `display_name`, `description`, `labels` and `launch_stage`
		  fields are all required.
		* The first label of the monitored resource descriptor must be
		  `resource_container`. There are legacy monitored resource descritptors
		  start with `project_id`.
		* It must include a `location` label.
		* Maximum of default 5 service defined monitored resource descriptors
		  is allowed per service.
		* Maximum of default 10 labels per monitored resource is allowed.

		The default maximum limit can be overridden. Please follow
		https://cloud.google.com/monitoring/quotas

		Fields (total 9, in which 6 are exported)
			Description string
				Optional. A detailed description of the monitored resource type that might
				be used in documentation.

			DisplayName 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"`.

			Labels []*label.LabelDescriptor
				Required. A set of labels used to describe instances of this monitored
				resource type.
				The label key name must follow:

				* Only upper and lower-case letters, digits and underscores (_) are
				  allowed.
				* Label name must start with a letter or digit.
				* The maximum length of a label name is 100 characters.

				For example, an individual Google Cloud SQL database is
				identified by values for the labels `database_id` and `location`.

			LaunchStage api.LaunchStage
				Optional. The launch stage of the monitored resource definition.

			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}"`.

			Type string
				Required. The monitored resource type. For example, the type
				`cloudsql_database` represents databases in Google Cloud SQL.

				All service defined monitored resource types must be prefixed with the
				service name, in the format of `{service name}/{relative resource name}`.
				The relative resource name must follow:

				* Only upper and lower-case letters and digits are allowed.
				* It must start with upper case character and is recommended to use Upper
				  Camel Case style.
				* The maximum number of characters allowed for the relative_resource_name
				  is 100.

				Note there are legacy service monitored resources not following this rule.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 11, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use MonitoredResourceDescriptor.ProtoReflect.Descriptor instead.

			(*T) GetDescription() string
			(*T) GetDisplayName() string
			(*T) GetLabels() []*label.LabelDescriptor
			(*T) GetLaunchStage() api.LaunchStage
			(*T) GetName() string
			(*T) GetType() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least 8, all are exported)
			func google.golang.org/genproto/googleapis/logging/v2.(*ListMonitoredResourceDescriptorsResponse).GetResourceDescriptors() []*MonitoredResourceDescriptor
			func google.golang.org/genproto/googleapis/monitoring/v3.(*ListMonitoredResourceDescriptorsResponse).GetResourceDescriptors() []*MonitoredResourceDescriptor
			func google.golang.org/genproto/googleapis/monitoring/v3.MetricServiceClient.GetMonitoredResourceDescriptor(ctx context.Context, in *monitoring.GetMonitoredResourceDescriptorRequest, opts ...grpc.CallOption) (*MonitoredResourceDescriptor, error)
			func google.golang.org/genproto/googleapis/monitoring/v3.MetricServiceServer.GetMonitoredResourceDescriptor(context.Context, *monitoring.GetMonitoredResourceDescriptorRequest) (*MonitoredResourceDescriptor, error)
			func google.golang.org/genproto/googleapis/monitoring/v3.(*UnimplementedMetricServiceServer).GetMonitoredResourceDescriptor(context.Context, *monitoring.GetMonitoredResourceDescriptorRequest) (*MonitoredResourceDescriptor, error)
			func cloud.google.com/go/logging/apiv2.(*MonitoredResourceDescriptorIterator).Next() (*MonitoredResourceDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).GetMonitoredResourceDescriptor(ctx context.Context, req *monitoringpb.GetMonitoredResourceDescriptorRequest, opts ...gax.CallOption) (*MonitoredResourceDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*MonitoredResourceDescriptorIterator).Next() (*MonitoredResourceDescriptor, error)

	 type MonitoredResourceMetadata (struct)
		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.

		Fields (total 5, in which 2 are exported)
			SystemLabels *structpb.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 }

			UserLabels map[string]string
				Output only. A map of user-defined metadata labels.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use MonitoredResourceMetadata.ProtoReflect.Descriptor instead.

			(*T) GetSystemLabels() *structpb.Struct
			(*T) GetUserLabels() map[string]string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func google.golang.org/genproto/googleapis/monitoring/v3.(*TimeSeries).GetMetadata() *MonitoredResourceMetadata


Package-Level Functions (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func file_google_api_monitored_resource_proto_init()
	 func file_google_api_monitored_resource_proto_rawDescGZIP() []byte
	 func init()
Package-Level Variables (total 7, in which 1 are exported)

	  var File_google_api_monitored_resource_proto protoreflect.FileDescriptor
	/* 6 unexporteds ... *//* 6 unexporteds: */
	  var file_google_api_monitored_resource_proto_depIdxs []int32
	  var file_google_api_monitored_resource_proto_goTypes []interface{}
	  var file_google_api_monitored_resource_proto_msgTypes []impl.MessageInfo
	  var file_google_api_monitored_resource_proto_rawDesc []byte
	  var file_google_api_monitored_resource_proto_rawDescData []byte
	  var file_google_api_monitored_resource_proto_rawDescOnce sync.Once

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.