package google.monitoring.metricsscope.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.

• rpc GetMetricsScope (GetMetricsScopeRequest, MetricsScope)

  metrics_scopes.proto:46

  Returns a specific `Metrics Scope`.

  message GetMetricsScopeRequest

  metrics_scopes.proto:90

  Request for the `GetMetricsScope` method.

  • string name = 1

    Required. The resource name of the `Metrics Scope`. Example: `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}`

• rpc ListMetricsScopesByMonitoredProject (ListMetricsScopesByMonitoredProjectRequest, ListMetricsScopesByMonitoredProjectResponse)

  metrics_scopes.proto:56

  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.

  message ListMetricsScopesByMonitoredProjectRequest

  metrics_scopes.proto:103

  Request for the `ListMetricsScopesByMonitoredProject` method.

  • string monitored_resource_container = 1

    Required. The resource name of the `Monitored Project` being requested. Example: `projects/{MONITORED_PROJECT_ID_OR_NUMBER}`

  message ListMetricsScopesByMonitoredProjectResponse

  metrics_scopes.proto:111

  Response for the `ListMetricsScopesByMonitoredProject` method.

  • repeated MetricsScope metrics_scopes = 1

    A set of all metrics scopes that the specified monitored project has been added to.

• rpc CreateMonitoredProject (CreateMonitoredProjectRequest, longrunning.Operation)

  metrics_scopes.proto:64

  Adds a `MonitoredProject` with the given project ID to the specified `Metrics Scope`.

  message CreateMonitoredProjectRequest

  metrics_scopes.proto:118

  Request for the `CreateMonitoredProject` method.

  • string parent = 1

    Required. The resource name of the existing `Metrics Scope` that will monitor this project. Example: `locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}`

  • optional MonitoredProject monitored_project = 2

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

• rpc DeleteMonitoredProject (DeleteMonitoredProjectRequest, longrunning.Operation)

  metrics_scopes.proto:77

  Deletes a `MonitoredProject` from the specified `Metrics Scope`.

  message DeleteMonitoredProjectRequest

  metrics_scopes.proto:138

  Request for the `DeleteMonitoredProject` method.

  • string name = 1

    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`

Represents a [Metrics Scope](https://cloud.google.com/monitoring/settings#concept-scope) in Cloud Monitoring, which specifies one or more Google projects and zero or more AWS accounts to monitor together.

Used as response type in: MetricsScopes.GetMetricsScope

Used as field type in: ListMetricsScopesByMonitoredProjectResponse

• string name = 1

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

• optional protobuf.Timestamp create_time = 2

  Output only. The time when this `Metrics Scope` was created.

• optional protobuf.Timestamp update_time = 3

  Output only. The time when this `Metrics Scope` record was last updated.

• repeated MonitoredProject monitored_projects = 4

  Output only. The list of projects monitored by this `Metrics Scope`.

A [project being monitored](https://cloud.google.com/monitoring/settings/multiple-projects#create-multi) by a `Metrics Scope`.

Used in: CreateMonitoredProjectRequest, MetricsScope

• string name = 1

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

• optional protobuf.Timestamp create_time = 6

  Output only. The time when this `MonitoredProject` was created.

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

• OperationMetadata.State state = 1

  Current state of the batch operation.

• optional protobuf.Timestamp create_time = 5

  The time when the batch request was received.

• optional protobuf.Timestamp update_time = 6

  The time when the operation result was last updated.

Batch operation states.

Used in: OperationMetadata

• STATE_UNSPECIFIED = 0

  Invalid.

• CREATED = 1

  Request has been received.

• RUNNING = 2

  Request is actively being processed.

• DONE = 3

  The batch processing is done.

• CANCELLED = 4

  The batch processing was cancelled.