Package cloud.google.com/go/monitoring/metricsscope/apiv1/metricsscopepb (v1.14.0)

Version 1.14.0

• 1.22.0 (latest)
• 1.21.2
• 1.20.4
• 1.19.0
• 1.18.2
• 1.17.1
• 1.16.3
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.3.0
• 0.2.0
• 0.1.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Variables

OperationMetadata_State_name, OperationMetadata_State_value

var (
	OperationMetadata_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATED",
		2: "RUNNING",
		3: "DONE",
		4: "CANCELLED",
	}
	OperationMetadata_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATED":           1,
		"RUNNING":           2,
		"DONE":              3,
		"CANCELLED":         4,
	}
)

Enum value maps for OperationMetadata_State.

File_google_monitoring_metricsscope_v1_metrics_scope_proto

var File_google_monitoring_metricsscope_v1_metrics_scope_proto protoreflect.FileDescriptor

File_google_monitoring_metricsscope_v1_metrics_scopes_proto

var File_google_monitoring_metricsscope_v1_metrics_scopes_proto protoreflect.FileDescriptor

Functions

func RegisterMetricsScopesServer

func RegisterMetricsScopesServer(s *grpc.Server, srv MetricsScopesServer)

CreateMonitoredProjectRequest

type CreateMonitoredProjectRequest struct {

	// Required. The resource name of the existing `Metrics Scope` that will monitor this
	// project.
	// Example:
	// `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The initial `MonitoredProject` configuration.
	// Specify only the `monitored_project.name` field. All other fields are
	// ignored. The `monitored_project.name` must be in the format:
	// `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}`
	MonitoredProject *MonitoredProject `protobuf:"bytes,2,opt,name=monitored_project,json=monitoredProject,proto3" json:"monitored_project,omitempty"`
	// contains filtered or unexported fields
}

Request for the CreateMonitoredProject method.

func (*CreateMonitoredProjectRequest) Descriptor

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

Deprecated: Use CreateMonitoredProjectRequest.ProtoReflect.Descriptor instead.

func (*CreateMonitoredProjectRequest) GetMonitoredProject

func (x *CreateMonitoredProjectRequest) GetMonitoredProject() *MonitoredProject

func (*CreateMonitoredProjectRequest) GetParent

func (x *CreateMonitoredProjectRequest) GetParent() string

func (*CreateMonitoredProjectRequest) ProtoMessage

func (*CreateMonitoredProjectRequest) ProtoMessage()

func (*CreateMonitoredProjectRequest) ProtoReflect

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

func (*CreateMonitoredProjectRequest) Reset

func (x *CreateMonitoredProjectRequest) Reset()

func (*CreateMonitoredProjectRequest) String

func (x *CreateMonitoredProjectRequest) String() string

DeleteMonitoredProjectRequest

type DeleteMonitoredProjectRequest struct {

	// Required. The resource name of the `MonitoredProject`.
	// Example:
	// `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}`
	//
	// Authorization requires the following [Google
	// IAM](https://cloud.google.com/iam) permissions on both the `Metrics Scope`
	// and on the `MonitoredProject`: `monitoring.metricsScopes.link`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for the DeleteMonitoredProject method.

func (*DeleteMonitoredProjectRequest) Descriptor

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

Deprecated: Use DeleteMonitoredProjectRequest.ProtoReflect.Descriptor instead.

func (*DeleteMonitoredProjectRequest) GetName

func (x *DeleteMonitoredProjectRequest) GetName() string

func (*DeleteMonitoredProjectRequest) ProtoMessage

func (*DeleteMonitoredProjectRequest) ProtoMessage()

func (*DeleteMonitoredProjectRequest) ProtoReflect

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

func (*DeleteMonitoredProjectRequest) Reset

func (x *DeleteMonitoredProjectRequest) Reset()

func (*DeleteMonitoredProjectRequest) String

func (x *DeleteMonitoredProjectRequest) String() string

GetMetricsScopeRequest

type GetMetricsScopeRequest struct {

	// Required. The resource name of the `Metrics Scope`.
	// Example:
	// `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for the GetMetricsScope method.

func (*GetMetricsScopeRequest) Descriptor

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

Deprecated: Use GetMetricsScopeRequest.ProtoReflect.Descriptor instead.

func (*GetMetricsScopeRequest) GetName

func (x *GetMetricsScopeRequest) GetName() string

func (*GetMetricsScopeRequest) ProtoMessage

func (*GetMetricsScopeRequest) ProtoMessage()

func (*GetMetricsScopeRequest) ProtoReflect

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

func (*GetMetricsScopeRequest) Reset

func (x *GetMetricsScopeRequest) Reset()

func (*GetMetricsScopeRequest) String

func (x *GetMetricsScopeRequest) String() string

ListMetricsScopesByMonitoredProjectRequest

type ListMetricsScopesByMonitoredProjectRequest struct {
	MonitoredResourceContainer string "" /* 141 byte string literal not displayed */

}

Request for the ListMetricsScopesByMonitoredProject method.

func (*ListMetricsScopesByMonitoredProjectRequest) Descriptor

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

Deprecated: Use ListMetricsScopesByMonitoredProjectRequest.ProtoReflect.Descriptor instead.

func (*ListMetricsScopesByMonitoredProjectRequest) GetMonitoredResourceContainer

func (x *ListMetricsScopesByMonitoredProjectRequest) GetMonitoredResourceContainer() string

func (*ListMetricsScopesByMonitoredProjectRequest) ProtoMessage

func (*ListMetricsScopesByMonitoredProjectRequest) ProtoMessage()

func (*ListMetricsScopesByMonitoredProjectRequest) ProtoReflect

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

func (*ListMetricsScopesByMonitoredProjectRequest) Reset

func (x *ListMetricsScopesByMonitoredProjectRequest) Reset()

func (*ListMetricsScopesByMonitoredProjectRequest) String

func (x *ListMetricsScopesByMonitoredProjectRequest) String() string

ListMetricsScopesByMonitoredProjectResponse

type ListMetricsScopesByMonitoredProjectResponse struct {

	// A set of all metrics scopes that the specified monitored project has been
	// added to.
	MetricsScopes []*MetricsScope `protobuf:"bytes,1,rep,name=metrics_scopes,json=metricsScopes,proto3" json:"metrics_scopes,omitempty"`
	// contains filtered or unexported fields
}

Response for the ListMetricsScopesByMonitoredProject method.

func (*ListMetricsScopesByMonitoredProjectResponse) Descriptor

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

Deprecated: Use ListMetricsScopesByMonitoredProjectResponse.ProtoReflect.Descriptor instead.

func (*ListMetricsScopesByMonitoredProjectResponse) GetMetricsScopes

func (x *ListMetricsScopesByMonitoredProjectResponse) GetMetricsScopes() []*MetricsScope

func (*ListMetricsScopesByMonitoredProjectResponse) ProtoMessage

func (*ListMetricsScopesByMonitoredProjectResponse) ProtoMessage()

func (*ListMetricsScopesByMonitoredProjectResponse) ProtoReflect

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

func (*ListMetricsScopesByMonitoredProjectResponse) Reset

func (x *ListMetricsScopesByMonitoredProjectResponse) Reset()

func (*ListMetricsScopesByMonitoredProjectResponse) String

func (x *ListMetricsScopesByMonitoredProjectResponse) String() string

MetricsScope

type MetricsScope struct {

	// Immutable. The resource name of the Monitoring Metrics Scope.
	// On input, the resource name can be specified with the
	// scoping project ID or number. On output, the resource name is
	// specified with the scoping project number.
	// Example:
	// `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The time when this `Metrics Scope` was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time when this `Metrics Scope` record was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The list of projects monitored by this `Metrics Scope`.
	MonitoredProjects []*MonitoredProject `protobuf:"bytes,4,rep,name=monitored_projects,json=monitoredProjects,proto3" json:"monitored_projects,omitempty"`
	// contains filtered or unexported fields
}

Represents a Metrics Scope in Cloud Monitoring, which specifies one or more Google projects and zero or more AWS accounts to monitor together.

func (*MetricsScope) Descriptor

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

Deprecated: Use MetricsScope.ProtoReflect.Descriptor instead.

func (*MetricsScope) GetCreateTime

func (x *MetricsScope) GetCreateTime() *timestamppb.Timestamp

func (*MetricsScope) GetMonitoredProjects

func (x *MetricsScope) GetMonitoredProjects() []*MonitoredProject

func (*MetricsScope) GetName

func (x *MetricsScope) GetName() string

func (*MetricsScope) GetUpdateTime

func (x *MetricsScope) GetUpdateTime() *timestamppb.Timestamp

func (*MetricsScope) ProtoMessage

func (*MetricsScope) ProtoMessage()

func (*MetricsScope) ProtoReflect

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

func (*MetricsScope) Reset

func (x *MetricsScope) Reset()

func (*MetricsScope) String

func (x *MetricsScope) String() string

MetricsScopesClient

type MetricsScopesClient interface {
	// Returns a specific `Metrics Scope`.
	GetMetricsScope(ctx context.Context, in *GetMetricsScopeRequest, opts ...grpc.CallOption) (*MetricsScope, error)
	// Returns a list of every `Metrics Scope` that a specific `MonitoredProject`
	// has been added to. The metrics scope representing the specified monitored
	// project will always be the first entry in the response.
	ListMetricsScopesByMonitoredProject(ctx context.Context, in *ListMetricsScopesByMonitoredProjectRequest, opts ...grpc.CallOption) (*ListMetricsScopesByMonitoredProjectResponse, error)
	// Adds a `MonitoredProject` with the given project ID
	// to the specified `Metrics Scope`.
	CreateMonitoredProject(ctx context.Context, in *CreateMonitoredProjectRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a `MonitoredProject` from the specified `Metrics Scope`.
	DeleteMonitoredProject(ctx context.Context, in *DeleteMonitoredProjectRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

MetricsScopesClient is the client API for MetricsScopes service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewMetricsScopesClient

func NewMetricsScopesClient(cc grpc.ClientConnInterface) MetricsScopesClient

MetricsScopesServer

type MetricsScopesServer interface {
	// Returns a specific `Metrics Scope`.
	GetMetricsScope(context.Context, *GetMetricsScopeRequest) (*MetricsScope, error)
	// Returns a list of every `Metrics Scope` that a specific `MonitoredProject`
	// has been added to. The metrics scope representing the specified monitored
	// project will always be the first entry in the response.
	ListMetricsScopesByMonitoredProject(context.Context, *ListMetricsScopesByMonitoredProjectRequest) (*ListMetricsScopesByMonitoredProjectResponse, error)
	// Adds a `MonitoredProject` with the given project ID
	// to the specified `Metrics Scope`.
	CreateMonitoredProject(context.Context, *CreateMonitoredProjectRequest) (*longrunningpb.Operation, error)
	// Deletes a `MonitoredProject` from the specified `Metrics Scope`.
	DeleteMonitoredProject(context.Context, *DeleteMonitoredProjectRequest) (*longrunningpb.Operation, error)
}

MetricsScopesServer is the server API for MetricsScopes service.

MonitoredProject

type MonitoredProject struct {

	// Immutable. The resource name of the `MonitoredProject`. On input, the resource name
	// includes the scoping project ID and monitored project ID. On output, it
	// contains the equivalent project numbers.
	// Example:
	// `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The time when this `MonitoredProject` was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

A project being monitored by a Metrics Scope.

func (*MonitoredProject) Descriptor

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

Deprecated: Use MonitoredProject.ProtoReflect.Descriptor instead.

func (*MonitoredProject) GetCreateTime

func (x *MonitoredProject) GetCreateTime() *timestamppb.Timestamp

func (*MonitoredProject) GetName

func (x *MonitoredProject) GetName() string

func (*MonitoredProject) ProtoMessage

func (*MonitoredProject) ProtoMessage()

func (*MonitoredProject) ProtoReflect

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

func (*MonitoredProject) Reset

func (x *MonitoredProject) Reset()

func (*MonitoredProject) String

func (x *MonitoredProject) String() string

OperationMetadata

type OperationMetadata struct {
	State OperationMetadata_State "" /* 127 byte string literal not displayed */

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

}

Contains metadata for longrunning operation for the edit Metrics Scope endpoints.

func (*OperationMetadata) Descriptor

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetCreateTime

func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*OperationMetadata) GetState

func (x *OperationMetadata) GetState() OperationMetadata_State

func (*OperationMetadata) GetUpdateTime

func (x *OperationMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

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

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

OperationMetadata_State

type OperationMetadata_State int32

Batch operation states.

OperationMetadata_STATE_UNSPECIFIED, OperationMetadata_CREATED, OperationMetadata_RUNNING, OperationMetadata_DONE, OperationMetadata_CANCELLED

const (
	// Invalid.
	OperationMetadata_STATE_UNSPECIFIED OperationMetadata_State = 0
	// Request has been received.
	OperationMetadata_CREATED OperationMetadata_State = 1
	// Request is actively being processed.
	OperationMetadata_RUNNING OperationMetadata_State = 2
	// The batch processing is done.
	OperationMetadata_DONE OperationMetadata_State = 3
	// The batch processing was cancelled.
	OperationMetadata_CANCELLED OperationMetadata_State = 4
)

func (OperationMetadata_State) Descriptor

func (OperationMetadata_State) Descriptor() protoreflect.EnumDescriptor

func (OperationMetadata_State) Enum

func (x OperationMetadata_State) Enum() *OperationMetadata_State

func (OperationMetadata_State) EnumDescriptor

func (OperationMetadata_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationMetadata_State.Descriptor instead.

func (OperationMetadata_State) Number

func (x OperationMetadata_State) Number() protoreflect.EnumNumber

func (OperationMetadata_State) String

func (x OperationMetadata_State) String() string

func (OperationMetadata_State) Type

func (OperationMetadata_State) Type() protoreflect.EnumType

UnimplementedMetricsScopesServer

type UnimplementedMetricsScopesServer struct {
}

UnimplementedMetricsScopesServer can be embedded to have forward compatible implementations.

func (*UnimplementedMetricsScopesServer) CreateMonitoredProject

func (*UnimplementedMetricsScopesServer) CreateMonitoredProject(context.Context, *CreateMonitoredProjectRequest) (*longrunningpb.Operation, error)

func (*UnimplementedMetricsScopesServer) DeleteMonitoredProject

func (*UnimplementedMetricsScopesServer) DeleteMonitoredProject(context.Context, *DeleteMonitoredProjectRequest) (*longrunningpb.Operation, error)

func (*UnimplementedMetricsScopesServer) GetMetricsScope

func (*UnimplementedMetricsScopesServer) GetMetricsScope(context.Context, *GetMetricsScopeRequest) (*MetricsScope, error)

func (*UnimplementedMetricsScopesServer) ListMetricsScopesByMonitoredProject

func (*UnimplementedMetricsScopesServer) ListMetricsScopesByMonitoredProject(context.Context, *ListMetricsScopesByMonitoredProjectRequest) (*ListMetricsScopesByMonitoredProjectResponse, error)