Package monitoring
Overview ▹
Index ▹
Variables
var Aggregation_Aligner_name = map[int32]string{
0: "ALIGN_NONE",
1: "ALIGN_DELTA",
2: "ALIGN_RATE",
3: "ALIGN_INTERPOLATE",
4: "ALIGN_NEXT_OLDER",
10: "ALIGN_MIN",
11: "ALIGN_MAX",
12: "ALIGN_MEAN",
13: "ALIGN_COUNT",
14: "ALIGN_SUM",
15: "ALIGN_STDDEV",
16: "ALIGN_COUNT_TRUE",
17: "ALIGN_FRACTION_TRUE",
18: "ALIGN_PERCENTILE_99",
19: "ALIGN_PERCENTILE_95",
20: "ALIGN_PERCENTILE_50",
21: "ALIGN_PERCENTILE_05",
}
var Aggregation_Aligner_value = map[string]int32{
"ALIGN_NONE": 0,
"ALIGN_DELTA": 1,
"ALIGN_RATE": 2,
"ALIGN_INTERPOLATE": 3,
"ALIGN_NEXT_OLDER": 4,
"ALIGN_MIN": 10,
"ALIGN_MAX": 11,
"ALIGN_MEAN": 12,
"ALIGN_COUNT": 13,
"ALIGN_SUM": 14,
"ALIGN_STDDEV": 15,
"ALIGN_COUNT_TRUE": 16,
"ALIGN_FRACTION_TRUE": 17,
"ALIGN_PERCENTILE_99": 18,
"ALIGN_PERCENTILE_95": 19,
"ALIGN_PERCENTILE_50": 20,
"ALIGN_PERCENTILE_05": 21,
}
var Aggregation_Reducer_name = map[int32]string{
0: "REDUCE_NONE",
1: "REDUCE_MEAN",
2: "REDUCE_MIN",
3: "REDUCE_MAX",
4: "REDUCE_SUM",
5: "REDUCE_STDDEV",
6: "REDUCE_COUNT",
7: "REDUCE_COUNT_TRUE",
8: "REDUCE_FRACTION_TRUE",
9: "REDUCE_PERCENTILE_99",
10: "REDUCE_PERCENTILE_95",
11: "REDUCE_PERCENTILE_50",
12: "REDUCE_PERCENTILE_05",
}
var Aggregation_Reducer_value = map[string]int32{
"REDUCE_NONE": 0,
"REDUCE_MEAN": 1,
"REDUCE_MIN": 2,
"REDUCE_MAX": 3,
"REDUCE_SUM": 4,
"REDUCE_STDDEV": 5,
"REDUCE_COUNT": 6,
"REDUCE_COUNT_TRUE": 7,
"REDUCE_FRACTION_TRUE": 8,
"REDUCE_PERCENTILE_99": 9,
"REDUCE_PERCENTILE_95": 10,
"REDUCE_PERCENTILE_50": 11,
"REDUCE_PERCENTILE_05": 12,
}
var ListTimeSeriesRequest_TimeSeriesView_name = map[int32]string{
0: "FULL",
1: "HEADERS",
}
var ListTimeSeriesRequest_TimeSeriesView_value = map[string]int32{
"FULL": 0,
"HEADERS": 1,
}
func RegisterGroupServiceServer ¶
func RegisterGroupServiceServer(s *grpc.Server, srv GroupServiceServer)
func RegisterMetricServiceServer ¶
func RegisterMetricServiceServer(s *grpc.Server, srv MetricServiceServer)
type Aggregation ¶
Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (`per_series_aligner`) followed by an optional reduction of the data across different time series (`cross_series_reducer`). For more details, see [Aggregation](/monitoring/api/learn_more#aggregation).
type Aggregation struct {
// The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
// alignment. If present, `alignmentPeriod` must be at least 60
// seconds. After per-time series alignment, each time series will
// contain data points only on the period boundaries. If
// `perSeriesAligner` is not specified or equals `ALIGN_NONE`, then
// this field is ignored. If `perSeriesAligner` is specified and
// does not equal `ALIGN_NONE`, then this field must be defined;
// otherwise an error is returned.
AlignmentPeriod *google_protobuf3.Duration `protobuf:"bytes,1,opt,name=alignment_period,json=alignmentPeriod" json:"alignment_period,omitempty"`
// The approach to be used to align individual time series. Not all
// alignment functions may be applied to all time series, depending
// on the metric type and value type of the original time
// series. Alignment may change the metric type or the value type of
// the time series.
//
// Time series data must be aligned in order to perform cross-time
// series reduction. If `crossSeriesReducer` is specified, then
// `perSeriesAligner` must be specified and not equal `ALIGN_NONE`
// and `alignmentPeriod` must be specified; otherwise, an error is
// returned.
PerSeriesAligner Aggregation_Aligner `protobuf:"varint,2,opt,name=per_series_aligner,json=perSeriesAligner,enum=google.monitoring.v3.Aggregation_Aligner" json:"per_series_aligner,omitempty"`
// The approach to be used to combine time series. Not all reducer
// functions may be applied to all time series, depending on the
// metric type and the value type of the original time
// series. Reduction may change the metric type of value type of the
// time series.
//
// Time series data must be aligned in order to perform cross-time
// series reduction. If `crossSeriesReducer` is specified, then
// `perSeriesAligner` must be specified and not equal `ALIGN_NONE`
// and `alignmentPeriod` must be specified; otherwise, an error is
// returned.
CrossSeriesReducer Aggregation_Reducer `protobuf:"varint,4,opt,name=cross_series_reducer,json=crossSeriesReducer,enum=google.monitoring.v3.Aggregation_Reducer" json:"cross_series_reducer,omitempty"`
// The set of fields to preserve when `crossSeriesReducer` is
// specified. The `groupByFields` determine how the time series are
// partitioned into subsets prior to applying the aggregation
// function. Each subset contains time series that have the same
// value for each of the grouping fields. Each individual time
// series is a member of exactly one subset. The
// `crossSeriesReducer` is applied to each subset of time series.
// It is not possible to reduce across different resource types, so
// this field implicitly contains `resource.type`. Fields not
// specified in `groupByFields` are aggregated away. If
// `groupByFields` is not specified and all the time series have
// the same resource type, then the time series are aggregated into
// a single output time series. If `crossSeriesReducer` is not
// defined, this field is ignored.
GroupByFields []string `protobuf:"bytes,5,rep,name=group_by_fields,json=groupByFields" json:"group_by_fields,omitempty"`
}
func (*Aggregation) Descriptor ¶
func (*Aggregation) Descriptor() ([]byte, []int)
func (*Aggregation) GetAlignmentPeriod ¶
func (m *Aggregation) GetAlignmentPeriod() *google_protobuf3.Duration
func (*Aggregation) GetCrossSeriesReducer ¶
func (m *Aggregation) GetCrossSeriesReducer() Aggregation_Reducer
func (*Aggregation) GetGroupByFields ¶
func (m *Aggregation) GetGroupByFields() []string
func (*Aggregation) GetPerSeriesAligner ¶
func (m *Aggregation) GetPerSeriesAligner() Aggregation_Aligner
func (*Aggregation) ProtoMessage ¶
func (*Aggregation) ProtoMessage()
func (*Aggregation) Reset ¶
func (m *Aggregation) Reset()
func (*Aggregation) String ¶
func (m *Aggregation) String() string
type Aggregation_Aligner ¶
The Aligner describes how to bring the data points in a single time series into temporal alignment.
type Aggregation_Aligner int32
const (
// No alignment. Raw data is returned. Not valid if cross-time
// series reduction is requested. The value type of the result is
// the same as the value type of the input.
Aggregation_ALIGN_NONE Aggregation_Aligner = 0
// Align and convert to delta metric type. This alignment is valid
// for cumulative metrics and delta metrics. Aligning an existing
// delta metric to a delta metric requires that the alignment
// period be increased. The value type of the result is the same
// as the value type of the input.
Aggregation_ALIGN_DELTA Aggregation_Aligner = 1
// Align and convert to a rate. This alignment is valid for
// cumulative metrics and delta metrics with numeric values. The output is a
// gauge metric with value type
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_ALIGN_RATE Aggregation_Aligner = 2
// Align by interpolating between adjacent points around the
// period boundary. This alignment is valid for gauge
// metrics with numeric values. The value type of the result is the same
// as the value type of the input.
Aggregation_ALIGN_INTERPOLATE Aggregation_Aligner = 3
// Align by shifting the oldest data point before the period
// boundary to the boundary. This alignment is valid for gauge
// metrics. The value type of the result is the same as the
// value type of the input.
Aggregation_ALIGN_NEXT_OLDER Aggregation_Aligner = 4
// Align time series via aggregation. The resulting data point in
// the alignment period is the minimum of all data points in the
// period. This alignment is valid for gauge and delta metrics with numeric
// values. The value type of the result is the same as the value
// type of the input.
Aggregation_ALIGN_MIN Aggregation_Aligner = 10
// Align time series via aggregation. The resulting data point in
// the alignment period is the maximum of all data points in the
// period. This alignment is valid for gauge and delta metrics with numeric
// values. The value type of the result is the same as the value
// type of the input.
Aggregation_ALIGN_MAX Aggregation_Aligner = 11
// Align time series via aggregation. The resulting data point in
// the alignment period is the average or arithmetic mean of all
// data points in the period. This alignment is valid for gauge and delta
// metrics with numeric values. The value type of the output is
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_ALIGN_MEAN Aggregation_Aligner = 12
// Align time series via aggregation. The resulting data point in
// the alignment period is the count of all data points in the
// period. This alignment is valid for gauge and delta metrics with numeric
// or Boolean values. The value type of the output is
// [INT64][google.api.MetricDescriptor.ValueType.INT64].
Aggregation_ALIGN_COUNT Aggregation_Aligner = 13
// Align time series via aggregation. The resulting data point in
// the alignment period is the sum of all data points in the
// period. This alignment is valid for gauge and delta metrics with numeric
// and distribution values. The value type of the output is the
// same as the value type of the input.
Aggregation_ALIGN_SUM Aggregation_Aligner = 14
// Align time series via aggregation. The resulting data point in
// the alignment period is the standard deviation of all data
// points in the period. This alignment is valid for gauge and delta metrics
// with numeric values. The value type of the output is
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_ALIGN_STDDEV Aggregation_Aligner = 15
// Align time series via aggregation. The resulting data point in
// the alignment period is the count of True-valued data points in the
// period. This alignment is valid for gauge metrics with
// Boolean values. The value type of the output is
// [INT64][google.api.MetricDescriptor.ValueType.INT64].
Aggregation_ALIGN_COUNT_TRUE Aggregation_Aligner = 16
// Align time series via aggregation. The resulting data point in
// the alignment period is the fraction of True-valued data points in the
// period. This alignment is valid for gauge metrics with Boolean values.
// The output value is in the range [0, 1] and has value type
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_ALIGN_FRACTION_TRUE Aggregation_Aligner = 17
// Align time series via aggregation. The resulting data point in
// the alignment period is the 99th percentile of all data
// points in the period. This alignment is valid for gauge and delta metrics
// with distribution values. The output is a gauge metric with value type
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_ALIGN_PERCENTILE_99 Aggregation_Aligner = 18
// Align time series via aggregation. The resulting data point in
// the alignment period is the 95th percentile of all data
// points in the period. This alignment is valid for gauge and delta metrics
// with distribution values. The output is a gauge metric with value type
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_ALIGN_PERCENTILE_95 Aggregation_Aligner = 19
// Align time series via aggregation. The resulting data point in
// the alignment period is the 50th percentile of all data
// points in the period. This alignment is valid for gauge and delta metrics
// with distribution values. The output is a gauge metric with value type
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_ALIGN_PERCENTILE_50 Aggregation_Aligner = 20
// Align time series via aggregation. The resulting data point in
// the alignment period is the 5th percentile of all data
// points in the period. This alignment is valid for gauge and delta metrics
// with distribution values. The output is a gauge metric with value type
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_ALIGN_PERCENTILE_05 Aggregation_Aligner = 21
)
func (Aggregation_Aligner) EnumDescriptor ¶
func (Aggregation_Aligner) EnumDescriptor() ([]byte, []int)
func (Aggregation_Aligner) String ¶
func (x Aggregation_Aligner) String() string
type Aggregation_Reducer ¶
A Reducer describes how to aggregate data points from multiple time series into a single time series.
type Aggregation_Reducer int32
const (
// No cross-time series reduction. The output of the aligner is
// returned.
Aggregation_REDUCE_NONE Aggregation_Reducer = 0
// Reduce by computing the mean across time series for each
// alignment period. This reducer is valid for delta and
// gauge metrics with numeric or distribution values. The value type of the
// output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_REDUCE_MEAN Aggregation_Reducer = 1
// Reduce by computing the minimum across time series for each
// alignment period. This reducer is valid for delta and
// gauge metrics with numeric values. The value type of the output
// is the same as the value type of the input.
Aggregation_REDUCE_MIN Aggregation_Reducer = 2
// Reduce by computing the maximum across time series for each
// alignment period. This reducer is valid for delta and
// gauge metrics with numeric values. The value type of the output
// is the same as the value type of the input.
Aggregation_REDUCE_MAX Aggregation_Reducer = 3
// Reduce by computing the sum across time series for each
// alignment period. This reducer is valid for delta and
// gauge metrics with numeric and distribution values. The value type of
// the output is the same as the value type of the input.
Aggregation_REDUCE_SUM Aggregation_Reducer = 4
// Reduce by computing the standard deviation across time series
// for each alignment period. This reducer is valid for delta
// and gauge metrics with numeric or distribution values. The value type of
// the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_REDUCE_STDDEV Aggregation_Reducer = 5
// Reduce by computing the count of data points across time series
// for each alignment period. This reducer is valid for delta
// and gauge metrics of numeric, Boolean, distribution, and string value
// type. The value type of the output is
// [INT64][google.api.MetricDescriptor.ValueType.INT64].
Aggregation_REDUCE_COUNT Aggregation_Reducer = 6
// Reduce by computing the count of True-valued data points across time
// series for each alignment period. This reducer is valid for delta
// and gauge metrics of Boolean value type. The value type of
// the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].
Aggregation_REDUCE_COUNT_TRUE Aggregation_Reducer = 7
// Reduce by computing the fraction of True-valued data points across time
// series for each alignment period. This reducer is valid for delta
// and gauge metrics of Boolean value type. The output value is in the
// range [0, 1] and has value type
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_REDUCE_FRACTION_TRUE Aggregation_Reducer = 8
// Reduce by computing 99th percentile of data points across time series
// for each alignment period. This reducer is valid for gauge and delta
// metrics of numeric and distribution type. The value of the output is
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]
Aggregation_REDUCE_PERCENTILE_99 Aggregation_Reducer = 9
// Reduce by computing 95th percentile of data points across time series
// for each alignment period. This reducer is valid for gauge and delta
// metrics of numeric and distribution type. The value of the output is
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]
Aggregation_REDUCE_PERCENTILE_95 Aggregation_Reducer = 10
// Reduce by computing 50th percentile of data points across time series
// for each alignment period. This reducer is valid for gauge and delta
// metrics of numeric and distribution type. The value of the output is
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]
Aggregation_REDUCE_PERCENTILE_50 Aggregation_Reducer = 11
// Reduce by computing 5th percentile of data points across time series
// for each alignment period. This reducer is valid for gauge and delta
// metrics of numeric and distribution type. The value of the output is
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]
Aggregation_REDUCE_PERCENTILE_05 Aggregation_Reducer = 12
)
func (Aggregation_Reducer) EnumDescriptor ¶
func (Aggregation_Reducer) EnumDescriptor() ([]byte, []int)
func (Aggregation_Reducer) String ¶
func (x Aggregation_Reducer) String() string
type CreateGroupRequest ¶
The `CreateGroup` request.
type CreateGroupRequest struct {
// The project in which to create the group. The format is
// `"projects/{project_id_or_number}"`.
Name string `protobuf:"bytes,4,opt,name=name" json:"name,omitempty"`
// A group definition. It is an error to define the `name` field because
// the system assigns the name.
Group *Group `protobuf:"bytes,2,opt,name=group" json:"group,omitempty"`
// If true, validate this request but do not create the group.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly" json:"validate_only,omitempty"`
}
func (*CreateGroupRequest) Descriptor ¶
func (*CreateGroupRequest) Descriptor() ([]byte, []int)
func (*CreateGroupRequest) GetGroup ¶
func (m *CreateGroupRequest) GetGroup() *Group
func (*CreateGroupRequest) GetName ¶
func (m *CreateGroupRequest) GetName() string
func (*CreateGroupRequest) GetValidateOnly ¶
func (m *CreateGroupRequest) GetValidateOnly() bool
func (*CreateGroupRequest) ProtoMessage ¶
func (*CreateGroupRequest) ProtoMessage()
func (*CreateGroupRequest) Reset ¶
func (m *CreateGroupRequest) Reset()
func (*CreateGroupRequest) String ¶
func (m *CreateGroupRequest) String() string
type CreateMetricDescriptorRequest ¶
The `CreateMetricDescriptor` request.
type CreateMetricDescriptorRequest struct {
// The project on which to execute the request. The format is
// `"projects/{project_id_or_number}"`.
Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
// The new [custom metric](/monitoring/custom-metrics)
// descriptor.
MetricDescriptor *google_api5.MetricDescriptor `protobuf:"bytes,2,opt,name=metric_descriptor,json=metricDescriptor" json:"metric_descriptor,omitempty"`
}
func (*CreateMetricDescriptorRequest) Descriptor ¶
func (*CreateMetricDescriptorRequest) Descriptor() ([]byte, []int)
func (*CreateMetricDescriptorRequest) GetMetricDescriptor ¶
func (m *CreateMetricDescriptorRequest) GetMetricDescriptor() *google_api5.MetricDescriptor
func (*CreateMetricDescriptorRequest) GetName ¶
func (m *CreateMetricDescriptorRequest) GetName() string
func (*CreateMetricDescriptorRequest) ProtoMessage ¶
func (*CreateMetricDescriptorRequest) ProtoMessage()
func (*CreateMetricDescriptorRequest) Reset ¶
func (m *CreateMetricDescriptorRequest) Reset()
func (*CreateMetricDescriptorRequest) String ¶
func (m *CreateMetricDescriptorRequest) String() string
type CreateTimeSeriesError ¶
Describes the result of a failed request to write data to a time series.
type CreateTimeSeriesError struct {
// The time series, including the `Metric`, `MonitoredResource`,
// and `Point`s (including timestamp and value) that resulted
// in the error. This field provides all of the context that
// would be needed to retry the operation.
TimeSeries *TimeSeries `protobuf:"bytes,1,opt,name=time_series,json=timeSeries" json:"time_series,omitempty"`
// The status of the requested write operation.
Status *google_rpc.Status `protobuf:"bytes,2,opt,name=status" json:"status,omitempty"`
}
func (*CreateTimeSeriesError) Descriptor ¶
func (*CreateTimeSeriesError) Descriptor() ([]byte, []int)
func (*CreateTimeSeriesError) GetStatus ¶
func (m *CreateTimeSeriesError) GetStatus() *google_rpc.Status
func (*CreateTimeSeriesError) GetTimeSeries ¶
func (m *CreateTimeSeriesError) GetTimeSeries() *TimeSeries
func (*CreateTimeSeriesError) ProtoMessage ¶
func (*CreateTimeSeriesError) ProtoMessage()
func (*CreateTimeSeriesError) Reset ¶
func (m *CreateTimeSeriesError) Reset()
func (*CreateTimeSeriesError) String ¶
func (m *CreateTimeSeriesError) String() string
type CreateTimeSeriesRequest ¶
The `CreateTimeSeries` request.
type CreateTimeSeriesRequest struct {
// The project on which to execute the request. The format is
// `"projects/{project_id_or_number}"`.
Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
// The new data to be added to a list of time series.
// Adds at most one data point to each of several time series. The new data
// point must be more recent than any other point in its time series. Each
// `TimeSeries` value must fully specify a unique time series by supplying
// all label values for the metric and the monitored resource.
TimeSeries []*TimeSeries `protobuf:"bytes,2,rep,name=time_series,json=timeSeries" json:"time_series,omitempty"`
}
func (*CreateTimeSeriesRequest) Descriptor ¶
func (*CreateTimeSeriesRequest) Descriptor() ([]byte, []int)
func (*CreateTimeSeriesRequest) GetName ¶
func (m *CreateTimeSeriesRequest) GetName() string
func (*CreateTimeSeriesRequest) GetTimeSeries ¶
func (m *CreateTimeSeriesRequest) GetTimeSeries() []*TimeSeries
func (*CreateTimeSeriesRequest) ProtoMessage ¶
func (*CreateTimeSeriesRequest) ProtoMessage()
func (*CreateTimeSeriesRequest) Reset ¶
func (m *CreateTimeSeriesRequest) Reset()
func (*CreateTimeSeriesRequest) String ¶
func (m *CreateTimeSeriesRequest) String() string
type DeleteGroupRequest ¶
The `DeleteGroup` request. You can only delete a group if it has no children.
type DeleteGroupRequest struct {
// The group to delete. The format is
// `"projects/{project_id_or_number}/groups/{group_id}"`.
Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
}
func (*DeleteGroupRequest) Descriptor ¶
func (*DeleteGroupRequest) Descriptor() ([]byte, []int)
func (*DeleteGroupRequest) GetName ¶
func (m *DeleteGroupRequest) GetName() string
func (*DeleteGroupRequest) ProtoMessage ¶
func (*DeleteGroupRequest) ProtoMessage()
func (*DeleteGroupRequest) Reset ¶
func (m *DeleteGroupRequest) Reset()
func (*DeleteGroupRequest) String ¶
func (m *DeleteGroupRequest) String() string
type DeleteMetricDescriptorRequest ¶
The `DeleteMetricDescriptor` request.
type DeleteMetricDescriptorRequest struct {
// The metric descriptor on which to execute the request. The format is
// `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`.
// An example of `{metric_id}` is:
// `"custom.googleapis.com/my_test_metric"`.
Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
}
func (*DeleteMetricDescriptorRequest) Descriptor ¶
func (*DeleteMetricDescriptorRequest) Descriptor() ([]byte, []int)
func (*DeleteMetricDescriptorRequest) GetName ¶
func (m *DeleteMetricDescriptorRequest) GetName() string
func (*DeleteMetricDescriptorRequest) ProtoMessage ¶
func (*DeleteMetricDescriptorRequest) ProtoMessage()
func (*DeleteMetricDescriptorRequest) Reset ¶
func (m *DeleteMetricDescriptorRequest) Reset()
func (*DeleteMetricDescriptorRequest) String ¶
func (m *DeleteMetricDescriptorRequest) String() string
type GetGroupRequest ¶
The `GetGroup` request.
type GetGroupRequest struct {
// The group to retrieve. The format is
// `"projects/{project_id_or_number}/groups/{group_id}"`.
Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
}
func (*GetGroupRequest) Descriptor ¶
func (*GetGroupRequest) Descriptor() ([]byte, []int)
func (*GetGroupRequest) GetName ¶
func (m *GetGroupRequest) GetName() string
func (*GetGroupRequest) ProtoMessage ¶
func (*GetGroupRequest) ProtoMessage()
func (*GetGroupRequest) Reset ¶
func (m *GetGroupRequest) Reset()
func (*GetGroupRequest) String ¶
func (m *GetGroupRequest) String() string
type GetMetricDescriptorRequest ¶
The `GetMetricDescriptor` request.
type GetMetricDescriptorRequest struct {
// The metric descriptor on which to execute the request. The format is
// `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`.
// An example value of `{metric_id}` is
// `"compute.googleapis.com/instance/disk/read_bytes_count"`.
Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
}
func (*GetMetricDescriptorRequest) Descriptor ¶
func (*GetMetricDescriptorRequest) Descriptor() ([]byte, []int)
func (*GetMetricDescriptorRequest) GetName ¶
func (m *GetMetricDescriptorRequest) GetName() string
func (*GetMetricDescriptorRequest) ProtoMessage ¶
func (*GetMetricDescriptorRequest) ProtoMessage()
func (*GetMetricDescriptorRequest) Reset ¶
func (m *GetMetricDescriptorRequest) Reset()
func (*GetMetricDescriptorRequest) String ¶
func (m *GetMetricDescriptorRequest) String() string
type GetMonitoredResourceDescriptorRequest ¶
The `GetMonitoredResourceDescriptor` request.
type GetMonitoredResourceDescriptorRequest struct {
// The monitored resource descriptor to get. The format is
// `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`.
// The `{resource_type}` is a predefined type, such as
// `cloudsql_database`.
Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
}
func (*GetMonitoredResourceDescriptorRequest) Descriptor ¶
func (*GetMonitoredResourceDescriptorRequest) Descriptor() ([]byte, []int)
func (*GetMonitoredResourceDescriptorRequest) GetName ¶
func (m *GetMonitoredResourceDescriptorRequest) GetName() string
func (*GetMonitoredResourceDescriptorRequest) ProtoMessage ¶
func (*GetMonitoredResourceDescriptorRequest) ProtoMessage()
func (*GetMonitoredResourceDescriptorRequest) Reset ¶
func (m *GetMonitoredResourceDescriptorRequest) Reset()
func (*GetMonitoredResourceDescriptorRequest) String ¶
func (m *GetMonitoredResourceDescriptorRequest) String() string
type Group ¶
The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.
Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.
For example, consider an infrastructure running a set of instances with two user-defined tags: `"environment"` and `"role"`. A parent group has a filter, `environment="production"`. A child of that parent group has a filter, `role="transcoder"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment.
The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
type Group struct {
// Output only. The name of this group. The format is
// `"projects/{project_id_or_number}/groups/{group_id}"`.
// When creating a group, this field is ignored and a new name is created
// consisting of the project specified in the call to `CreateGroup`
// and a unique `{group_id}` that is generated automatically.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// A user-assigned name for this group, used only for display purposes.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
// The name of the group's parent, if it has one.
// The format is `"projects/{project_id_or_number}/groups/{group_id}"`.
// For groups with no parent, `parentName` is the empty string, `""`.
ParentName string `protobuf:"bytes,3,opt,name=parent_name,json=parentName" json:"parent_name,omitempty"`
// The filter used to determine which monitored resources belong to this group.
Filter string `protobuf:"bytes,5,opt,name=filter" json:"filter,omitempty"`
// If true, the members of this group are considered to be a cluster.
// The system can perform additional analysis on groups that are clusters.
IsCluster bool `protobuf:"varint,6,opt,name=is_cluster,json=isCluster" json:"is_cluster,omitempty"`
}
func (*Group) Descriptor ¶
func (*Group) Descriptor() ([]byte, []int)
func (*Group) GetDisplayName ¶
func (m *Group) GetDisplayName() string
func (*Group) GetFilter ¶
func (m *Group) GetFilter() string
func (*Group) GetIsCluster ¶
func (m *Group) GetIsCluster() bool
func (*Group) GetName ¶
func (m *Group) GetName() string
func (*Group) GetParentName ¶
func (m *Group) GetParentName() string
func (*Group) ProtoMessage ¶
func (*Group) ProtoMessage()
func (*Group) Reset ¶
func (m *Group) Reset()
func (*Group) String ¶
func (m *Group) String() string
type GroupServiceClient ¶
type GroupServiceClient interface {
// Lists the existing groups.
ListGroups(ctx context.Context, in *ListGroupsRequest, opts ...grpc.CallOption) (*ListGroupsResponse, error)
// Gets a single group.
GetGroup(ctx context.Context, in *GetGroupRequest, opts ...grpc.CallOption) (*Group, error)
// Creates a new group.
CreateGroup(ctx context.Context, in *CreateGroupRequest, opts ...grpc.CallOption) (*Group, error)
// Updates an existing group.
// You can change any group attributes except `name`.
UpdateGroup(ctx context.Context, in *UpdateGroupRequest, opts ...grpc.CallOption) (*Group, error)
// Deletes an existing group.
DeleteGroup(ctx context.Context, in *DeleteGroupRequest, opts ...grpc.CallOption) (*google_protobuf4.Empty, error)
// Lists the monitored resources that are members of a group.
ListGroupMembers(ctx context.Context, in *ListGroupMembersRequest, opts ...grpc.CallOption) (*ListGroupMembersResponse, error)
}
func NewGroupServiceClient ¶
func NewGroupServiceClient(cc *grpc.ClientConn) GroupServiceClient
type GroupServiceServer ¶
type GroupServiceServer interface {
// Lists the existing groups.
ListGroups(context.Context, *ListGroupsRequest) (*ListGroupsResponse, error)
// Gets a single group.
GetGroup(context.Context, *GetGroupRequest) (*Group, error)
// Creates a new group.
CreateGroup(context.Context, *CreateGroupRequest) (*Group, error)
// Updates an existing group.
// You can change any group attributes except `name`.
UpdateGroup(context.Context, *UpdateGroupRequest) (*Group, error)
// Deletes an existing group.
DeleteGroup(context.Context, *DeleteGroupRequest) (*google_protobuf4.Empty, error)
// Lists the monitored resources that are members of a group.
ListGroupMembers(context.Context, *ListGroupMembersRequest) (*ListGroupMembersResponse, error)
}
type ListGroupMembersRequest ¶
The `ListGroupMembers` request.
type ListGroupMembersRequest struct {
// The group whose members are listed. The format is
// `"projects/{project_id_or_number}/groups/{group_id}"`.
Name string `protobuf:"bytes,7,opt,name=name" json:"name,omitempty"`
// A positive number that is the maximum number of results to return.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return additional results from the previous method call.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
// An optional [list filter](/monitoring/api/learn_more#filtering) describing
// the members to be returned. The filter may reference the type, labels, and
// metadata of monitored resources that comprise the group.
// For example, to return only resources representing Compute Engine VM
// instances, use this filter:
//
// resource.type = "gce_instance"
Filter string `protobuf:"bytes,5,opt,name=filter" json:"filter,omitempty"`
// An optional time interval for which results should be returned. Only
// members that were part of the group during the specified interval are
// included in the response. If no interval is provided then the group
// membership over the last minute is returned.
Interval *TimeInterval `protobuf:"bytes,6,opt,name=interval" json:"interval,omitempty"`
}
func (*ListGroupMembersRequest) Descriptor ¶
func (*ListGroupMembersRequest) Descriptor() ([]byte, []int)
func (*ListGroupMembersRequest) GetFilter ¶
func (m *ListGroupMembersRequest) GetFilter() string
func (*ListGroupMembersRequest) GetInterval ¶
func (m *ListGroupMembersRequest) GetInterval() *TimeInterval
func (*ListGroupMembersRequest) GetName ¶
func (m *ListGroupMembersRequest) GetName() string
func (*ListGroupMembersRequest) GetPageSize ¶
func (m *ListGroupMembersRequest) GetPageSize() int32
func (*ListGroupMembersRequest) GetPageToken ¶
func (m *ListGroupMembersRequest) GetPageToken() string
func (*ListGroupMembersRequest) ProtoMessage ¶
func (*ListGroupMembersRequest) ProtoMessage()
func (*ListGroupMembersRequest) Reset ¶
func (m *ListGroupMembersRequest) Reset()
func (*ListGroupMembersRequest) String ¶
func (m *ListGroupMembersRequest) String() string
type ListGroupMembersResponse ¶
The `ListGroupMembers` response.
type ListGroupMembersResponse struct {
// A set of monitored resources in the group.
Members []*google_api4.MonitoredResource `protobuf:"bytes,1,rep,name=members" json:"members,omitempty"`
// If there are more results than have been returned, then this field is
// set to a non-empty value. To see the additional results, use that value as
// `pageToken` in the next call to this method.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
// The total number of elements matching this request.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize" json:"total_size,omitempty"`
}
func (*ListGroupMembersResponse) Descriptor ¶
func (*ListGroupMembersResponse) Descriptor() ([]byte, []int)
func (*ListGroupMembersResponse) GetMembers ¶
func (m *ListGroupMembersResponse) GetMembers() []*google_api4.MonitoredResource
func (*ListGroupMembersResponse) GetNextPageToken ¶
func (m *ListGroupMembersResponse) GetNextPageToken() string
func (*ListGroupMembersResponse) GetTotalSize ¶
func (m *ListGroupMembersResponse) GetTotalSize() int32
func (*ListGroupMembersResponse) ProtoMessage ¶
func (*ListGroupMembersResponse) ProtoMessage()
func (*ListGroupMembersResponse) Reset ¶
func (m *ListGroupMembersResponse) Reset()
func (*ListGroupMembersResponse) String ¶
func (m *ListGroupMembersResponse) String() string
type ListGroupsRequest ¶
The `ListGroup` request.
type ListGroupsRequest struct {
// The project whose groups are to be listed. The format is
// `"projects/{project_id_or_number}"`.
Name string `protobuf:"bytes,7,opt,name=name" json:"name,omitempty"`
// An optional filter consisting of a single group name. The filters limit the
// groups returned based on their parent-child relationship with the specified
// group. If no filter is specified, all groups are returned.
//
// Types that are valid to be assigned to Filter:
// *ListGroupsRequest_ChildrenOfGroup
// *ListGroupsRequest_AncestorsOfGroup
// *ListGroupsRequest_DescendantsOfGroup
Filter isListGroupsRequest_Filter `protobuf_oneof:"filter"`
// A positive number that is the maximum number of results to return.
PageSize int32 `protobuf:"varint,5,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return additional results from the previous method call.
PageToken string `protobuf:"bytes,6,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
func (*ListGroupsRequest) Descriptor ¶
func (*ListGroupsRequest) Descriptor() ([]byte, []int)
func (*ListGroupsRequest) GetAncestorsOfGroup ¶
func (m *ListGroupsRequest) GetAncestorsOfGroup() string
func (*ListGroupsRequest) GetChildrenOfGroup ¶
func (m *ListGroupsRequest) GetChildrenOfGroup() string
func (*ListGroupsRequest) GetDescendantsOfGroup ¶
func (m *ListGroupsRequest) GetDescendantsOfGroup() string
func (*ListGroupsRequest) GetFilter ¶
func (m *ListGroupsRequest) GetFilter() isListGroupsRequest_Filter
func (*ListGroupsRequest) GetName ¶
func (m *ListGroupsRequest) GetName() string
func (*ListGroupsRequest) GetPageSize ¶
func (m *ListGroupsRequest) GetPageSize() int32
func (*ListGroupsRequest) GetPageToken ¶
func (m *ListGroupsRequest) GetPageToken() string
func (*ListGroupsRequest) ProtoMessage ¶
func (*ListGroupsRequest) ProtoMessage()
func (*ListGroupsRequest) Reset ¶
func (m *ListGroupsRequest) Reset()
func (*ListGroupsRequest) String ¶
func (m *ListGroupsRequest) String() string
func (*ListGroupsRequest) XXX_OneofFuncs ¶
func (*ListGroupsRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type ListGroupsRequest_AncestorsOfGroup ¶
type ListGroupsRequest_AncestorsOfGroup struct {
AncestorsOfGroup string `protobuf:"bytes,3,opt,name=ancestors_of_group,json=ancestorsOfGroup,oneof"`
}
type ListGroupsRequest_ChildrenOfGroup ¶
type ListGroupsRequest_ChildrenOfGroup struct {
ChildrenOfGroup string `protobuf:"bytes,2,opt,name=children_of_group,json=childrenOfGroup,oneof"`
}
type ListGroupsRequest_DescendantsOfGroup ¶
type ListGroupsRequest_DescendantsOfGroup struct {
DescendantsOfGroup string `protobuf:"bytes,4,opt,name=descendants_of_group,json=descendantsOfGroup,oneof"`
}
type ListGroupsResponse ¶
The `ListGroups` response.
type ListGroupsResponse struct {
// The groups that match the specified filters.
Group []*Group `protobuf:"bytes,1,rep,name=group" json:"group,omitempty"`
// If there are more results than have been returned, then this field is set
// to a non-empty value. To see the additional results,
// use that value as `pageToken` in the next call to this method.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
func (*ListGroupsResponse) Descriptor ¶
func (*ListGroupsResponse) Descriptor() ([]byte, []int)
func (*ListGroupsResponse) GetGroup ¶
func (m *ListGroupsResponse) GetGroup() []*Group
func (*ListGroupsResponse) GetNextPageToken ¶
func (m *ListGroupsResponse) GetNextPageToken() string
func (*ListGroupsResponse) ProtoMessage ¶
func (*ListGroupsResponse) ProtoMessage()
func (*ListGroupsResponse) Reset ¶
func (m *ListGroupsResponse) Reset()
func (*ListGroupsResponse) String ¶
func (m *ListGroupsResponse) String() string
type ListMetricDescriptorsRequest ¶
The `ListMetricDescriptors` request.
type ListMetricDescriptorsRequest struct {
// The project on which to execute the request. The format is
// `"projects/{project_id_or_number}"`.
Name string `protobuf:"bytes,5,opt,name=name" json:"name,omitempty"`
// If this field is empty, all custom and
// system-defined metric descriptors are returned.
// Otherwise, the [filter](/monitoring/api/v3/filters)
// specifies which metric descriptors are to be
// returned. For example, the following filter matches all
// [custom metrics](/monitoring/custom-metrics):
//
// metric.type = starts_with("custom.googleapis.com/")
Filter string `protobuf:"bytes,2,opt,name=filter" json:"filter,omitempty"`
// A positive number that is the maximum number of results to return.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return additional results from the previous method call.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
func (*ListMetricDescriptorsRequest) Descriptor ¶
func (*ListMetricDescriptorsRequest) Descriptor() ([]byte, []int)
func (*ListMetricDescriptorsRequest) GetFilter ¶
func (m *ListMetricDescriptorsRequest) GetFilter() string
func (*ListMetricDescriptorsRequest) GetName ¶
func (m *ListMetricDescriptorsRequest) GetName() string
func (*ListMetricDescriptorsRequest) GetPageSize ¶
func (m *ListMetricDescriptorsRequest) GetPageSize() int32
func (*ListMetricDescriptorsRequest) GetPageToken ¶
func (m *ListMetricDescriptorsRequest) GetPageToken() string
func (*ListMetricDescriptorsRequest) ProtoMessage ¶
func (*ListMetricDescriptorsRequest) ProtoMessage()
func (*ListMetricDescriptorsRequest) Reset ¶
func (m *ListMetricDescriptorsRequest) Reset()
func (*ListMetricDescriptorsRequest) String ¶
func (m *ListMetricDescriptorsRequest) String() string
type ListMetricDescriptorsResponse ¶
The `ListMetricDescriptors` response.
type ListMetricDescriptorsResponse struct {
// The metric descriptors that are available to the project
// and that match the value of `filter`, if present.
MetricDescriptors []*google_api5.MetricDescriptor `protobuf:"bytes,1,rep,name=metric_descriptors,json=metricDescriptors" json:"metric_descriptors,omitempty"`
// If there are more results than have been returned, then this field is set
// to a non-empty value. To see the additional results,
// use that value as `pageToken` in the next call to this method.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
func (*ListMetricDescriptorsResponse) Descriptor ¶
func (*ListMetricDescriptorsResponse) Descriptor() ([]byte, []int)
func (*ListMetricDescriptorsResponse) GetMetricDescriptors ¶
func (m *ListMetricDescriptorsResponse) GetMetricDescriptors() []*google_api5.MetricDescriptor
func (*ListMetricDescriptorsResponse) GetNextPageToken ¶
func (m *ListMetricDescriptorsResponse) GetNextPageToken() string
func (*ListMetricDescriptorsResponse) ProtoMessage ¶
func (*ListMetricDescriptorsResponse) ProtoMessage()
func (*ListMetricDescriptorsResponse) Reset ¶
func (m *ListMetricDescriptorsResponse) Reset()
func (*ListMetricDescriptorsResponse) String ¶
func (m *ListMetricDescriptorsResponse) String() string
type ListMonitoredResourceDescriptorsRequest ¶
The `ListMonitoredResourceDescriptors` request.
type ListMonitoredResourceDescriptorsRequest struct {
// The project on which to execute the request. The format is
// `"projects/{project_id_or_number}"`.
Name string `protobuf:"bytes,5,opt,name=name" json:"name,omitempty"`
// An optional [filter](/monitoring/api/v3/filters) describing
// the descriptors to be returned. The filter can reference
// the descriptor's type and labels. For example, the
// following filter returns only Google Compute Engine descriptors
// that have an `id` label:
//
// resource.type = starts_with("gce_") AND resource.label:id
Filter string `protobuf:"bytes,2,opt,name=filter" json:"filter,omitempty"`
// A positive number that is the maximum number of results to return.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return additional results from the previous method call.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
func (*ListMonitoredResourceDescriptorsRequest) Descriptor ¶
func (*ListMonitoredResourceDescriptorsRequest) Descriptor() ([]byte, []int)
func (*ListMonitoredResourceDescriptorsRequest) GetFilter ¶
func (m *ListMonitoredResourceDescriptorsRequest) GetFilter() string
func (*ListMonitoredResourceDescriptorsRequest) GetName ¶
func (m *ListMonitoredResourceDescriptorsRequest) GetName() string
func (*ListMonitoredResourceDescriptorsRequest) GetPageSize ¶
func (m *ListMonitoredResourceDescriptorsRequest) GetPageSize() int32
func (*ListMonitoredResourceDescriptorsRequest) GetPageToken ¶
func (m *ListMonitoredResourceDescriptorsRequest) GetPageToken() string
func (*ListMonitoredResourceDescriptorsRequest) ProtoMessage ¶
func (*ListMonitoredResourceDescriptorsRequest) ProtoMessage()
func (*ListMonitoredResourceDescriptorsRequest) Reset ¶
func (m *ListMonitoredResourceDescriptorsRequest) Reset()
func (*ListMonitoredResourceDescriptorsRequest) String ¶
func (m *ListMonitoredResourceDescriptorsRequest) String() string
type ListMonitoredResourceDescriptorsResponse ¶
The `ListMonitoredResourcDescriptors` response.
type ListMonitoredResourceDescriptorsResponse struct {
// The monitored resource descriptors that are available to this project
// and that match `filter`, if present.
ResourceDescriptors []*google_api4.MonitoredResourceDescriptor `protobuf:"bytes,1,rep,name=resource_descriptors,json=resourceDescriptors" json:"resource_descriptors,omitempty"`
// If there are more results than have been returned, then this field is set
// to a non-empty value. To see the additional results,
// use that value as `pageToken` in the next call to this method.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
func (*ListMonitoredResourceDescriptorsResponse) Descriptor ¶
func (*ListMonitoredResourceDescriptorsResponse) Descriptor() ([]byte, []int)
func (*ListMonitoredResourceDescriptorsResponse) GetNextPageToken ¶
func (m *ListMonitoredResourceDescriptorsResponse) GetNextPageToken() string
func (*ListMonitoredResourceDescriptorsResponse) GetResourceDescriptors ¶
func (m *ListMonitoredResourceDescriptorsResponse) GetResourceDescriptors() []*google_api4.MonitoredResourceDescriptor
func (*ListMonitoredResourceDescriptorsResponse) ProtoMessage ¶
func (*ListMonitoredResourceDescriptorsResponse) ProtoMessage()
func (*ListMonitoredResourceDescriptorsResponse) Reset ¶
func (m *ListMonitoredResourceDescriptorsResponse) Reset()
func (*ListMonitoredResourceDescriptorsResponse) String ¶
func (m *ListMonitoredResourceDescriptorsResponse) String() string
type ListTimeSeriesRequest ¶
The `ListTimeSeries` request.
type ListTimeSeriesRequest struct {
// The project on which to execute the request. The format is
// "projects/{project_id_or_number}".
Name string `protobuf:"bytes,10,opt,name=name" json:"name,omitempty"`
// A [monitoring filter](/monitoring/api/v3/filters) that specifies which time
// series should be returned. The filter must specify a single metric type,
// and can additionally specify metric labels and other information. For
// example:
//
// metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
// metric.label.instance_name = "my-instance-name"
Filter string `protobuf:"bytes,2,opt,name=filter" json:"filter,omitempty"`
// The time interval for which results should be returned. Only time series
// that contain data points in the specified interval are included
// in the response.
Interval *TimeInterval `protobuf:"bytes,4,opt,name=interval" json:"interval,omitempty"`
// By default, the raw time series data is returned.
// Use this field to combine multiple time series for different
// views of the data.
Aggregation *Aggregation `protobuf:"bytes,5,opt,name=aggregation" json:"aggregation,omitempty"`
// Specifies the order in which the points of the time series should
// be returned. By default, results are not ordered. Currently,
// this field must be left blank.
OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy" json:"order_by,omitempty"`
// Specifies which information is returned about the time series.
View ListTimeSeriesRequest_TimeSeriesView `protobuf:"varint,7,opt,name=view,enum=google.monitoring.v3.ListTimeSeriesRequest_TimeSeriesView" json:"view,omitempty"`
// A positive number that is the maximum number of results to return.
// When `view` field sets to `FULL`, it limits the number of `Points` server
// will return; if `view` field is `HEADERS`, it limits the number of
// `TimeSeries` server will return.
PageSize int32 `protobuf:"varint,8,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return additional results from the previous method call.
PageToken string `protobuf:"bytes,9,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
func (*ListTimeSeriesRequest) Descriptor ¶
func (*ListTimeSeriesRequest) Descriptor() ([]byte, []int)
func (*ListTimeSeriesRequest) GetAggregation ¶
func (m *ListTimeSeriesRequest) GetAggregation() *Aggregation
func (*ListTimeSeriesRequest) GetFilter ¶
func (m *ListTimeSeriesRequest) GetFilter() string
func (*ListTimeSeriesRequest) GetInterval ¶
func (m *ListTimeSeriesRequest) GetInterval() *TimeInterval
func (*ListTimeSeriesRequest) GetName ¶
func (m *ListTimeSeriesRequest) GetName() string
func (*ListTimeSeriesRequest) GetOrderBy ¶
func (m *ListTimeSeriesRequest) GetOrderBy() string
func (*ListTimeSeriesRequest) GetPageSize ¶
func (m *ListTimeSeriesRequest) GetPageSize() int32
func (*ListTimeSeriesRequest) GetPageToken ¶
func (m *ListTimeSeriesRequest) GetPageToken() string
func (*ListTimeSeriesRequest) GetView ¶
func (m *ListTimeSeriesRequest) GetView() ListTimeSeriesRequest_TimeSeriesView
func (*ListTimeSeriesRequest) ProtoMessage ¶
func (*ListTimeSeriesRequest) ProtoMessage()
func (*ListTimeSeriesRequest) Reset ¶
func (m *ListTimeSeriesRequest) Reset()
func (*ListTimeSeriesRequest) String ¶
func (m *ListTimeSeriesRequest) String() string
type ListTimeSeriesRequest_TimeSeriesView ¶
Controls which fields are returned by `ListTimeSeries`.
type ListTimeSeriesRequest_TimeSeriesView int32
const (
// Returns the identity of the metric(s), the time series,
// and the time series data.
ListTimeSeriesRequest_FULL ListTimeSeriesRequest_TimeSeriesView = 0
// Returns the identity of the metric and the time series resource,
// but not the time series data.
ListTimeSeriesRequest_HEADERS ListTimeSeriesRequest_TimeSeriesView = 1
)
func (ListTimeSeriesRequest_TimeSeriesView) EnumDescriptor ¶
func (ListTimeSeriesRequest_TimeSeriesView) EnumDescriptor() ([]byte, []int)
func (ListTimeSeriesRequest_TimeSeriesView) String ¶
func (x ListTimeSeriesRequest_TimeSeriesView) String() string
type ListTimeSeriesResponse ¶
The `ListTimeSeries` response.
type ListTimeSeriesResponse struct {
// One or more time series that match the filter included in the request.
TimeSeries []*TimeSeries `protobuf:"bytes,1,rep,name=time_series,json=timeSeries" json:"time_series,omitempty"`
// If there are more results than have been returned, then this field is set
// to a non-empty value. To see the additional results,
// use that value as `pageToken` in the next call to this method.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
func (*ListTimeSeriesResponse) Descriptor ¶
func (*ListTimeSeriesResponse) Descriptor() ([]byte, []int)
func (*ListTimeSeriesResponse) GetNextPageToken ¶
func (m *ListTimeSeriesResponse) GetNextPageToken() string
func (*ListTimeSeriesResponse) GetTimeSeries ¶
func (m *ListTimeSeriesResponse) GetTimeSeries() []*TimeSeries
func (*ListTimeSeriesResponse) ProtoMessage ¶
func (*ListTimeSeriesResponse) ProtoMessage()
func (*ListTimeSeriesResponse) Reset ¶
func (m *ListTimeSeriesResponse) Reset()
func (*ListTimeSeriesResponse) String ¶
func (m *ListTimeSeriesResponse) String() string
type MetricServiceClient ¶
type MetricServiceClient interface {
// Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.
ListMonitoredResourceDescriptors(ctx context.Context, in *ListMonitoredResourceDescriptorsRequest, opts ...grpc.CallOption) (*ListMonitoredResourceDescriptorsResponse, error)
// Gets a single monitored resource descriptor. This method does not require a Stackdriver account.
GetMonitoredResourceDescriptor(ctx context.Context, in *GetMonitoredResourceDescriptorRequest, opts ...grpc.CallOption) (*google_api4.MonitoredResourceDescriptor, error)
// Lists metric descriptors that match a filter. This method does not require a Stackdriver account.
ListMetricDescriptors(ctx context.Context, in *ListMetricDescriptorsRequest, opts ...grpc.CallOption) (*ListMetricDescriptorsResponse, error)
// Gets a single metric descriptor. This method does not require a Stackdriver account.
GetMetricDescriptor(ctx context.Context, in *GetMetricDescriptorRequest, opts ...grpc.CallOption) (*google_api5.MetricDescriptor, error)
// Creates a new metric descriptor.
// User-created metric descriptors define
// [custom metrics](/monitoring/custom-metrics).
CreateMetricDescriptor(ctx context.Context, in *CreateMetricDescriptorRequest, opts ...grpc.CallOption) (*google_api5.MetricDescriptor, error)
// Deletes a metric descriptor. Only user-created
// [custom metrics](/monitoring/custom-metrics) can be deleted.
DeleteMetricDescriptor(ctx context.Context, in *DeleteMetricDescriptorRequest, opts ...grpc.CallOption) (*google_protobuf4.Empty, error)
// Lists time series that match a filter. This method does not require a Stackdriver account.
ListTimeSeries(ctx context.Context, in *ListTimeSeriesRequest, opts ...grpc.CallOption) (*ListTimeSeriesResponse, error)
// Creates or adds data to one or more time series.
// The response is empty if all time series in the request were written.
// If any time series could not be written, a corresponding failure message is
// included in the error response.
CreateTimeSeries(ctx context.Context, in *CreateTimeSeriesRequest, opts ...grpc.CallOption) (*google_protobuf4.Empty, error)
}
func NewMetricServiceClient ¶
func NewMetricServiceClient(cc *grpc.ClientConn) MetricServiceClient
type MetricServiceServer ¶
type MetricServiceServer interface {
// Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.
ListMonitoredResourceDescriptors(context.Context, *ListMonitoredResourceDescriptorsRequest) (*ListMonitoredResourceDescriptorsResponse, error)
// Gets a single monitored resource descriptor. This method does not require a Stackdriver account.
GetMonitoredResourceDescriptor(context.Context, *GetMonitoredResourceDescriptorRequest) (*google_api4.MonitoredResourceDescriptor, error)
// Lists metric descriptors that match a filter. This method does not require a Stackdriver account.
ListMetricDescriptors(context.Context, *ListMetricDescriptorsRequest) (*ListMetricDescriptorsResponse, error)
// Gets a single metric descriptor. This method does not require a Stackdriver account.
GetMetricDescriptor(context.Context, *GetMetricDescriptorRequest) (*google_api5.MetricDescriptor, error)
// Creates a new metric descriptor.
// User-created metric descriptors define
// [custom metrics](/monitoring/custom-metrics).
CreateMetricDescriptor(context.Context, *CreateMetricDescriptorRequest) (*google_api5.MetricDescriptor, error)
// Deletes a metric descriptor. Only user-created
// [custom metrics](/monitoring/custom-metrics) can be deleted.
DeleteMetricDescriptor(context.Context, *DeleteMetricDescriptorRequest) (*google_protobuf4.Empty, error)
// Lists time series that match a filter. This method does not require a Stackdriver account.
ListTimeSeries(context.Context, *ListTimeSeriesRequest) (*ListTimeSeriesResponse, error)
// Creates or adds data to one or more time series.
// The response is empty if all time series in the request were written.
// If any time series could not be written, a corresponding failure message is
// included in the error response.
CreateTimeSeries(context.Context, *CreateTimeSeriesRequest) (*google_protobuf4.Empty, error)
}
type Point ¶
A single data point in a time series.
type Point struct {
// The time interval to which the data point applies. For GAUGE metrics, only
// the end time of the interval is used. For DELTA metrics, the start and end
// time should specify a non-zero interval, with subsequent points specifying
// contiguous and non-overlapping intervals. For CUMULATIVE metrics, the
// start and end time should specify a non-zero interval, with subsequent
// points specifying the same start time and increasing end times, until an
// event resets the cumulative value to zero and sets a new start time for the
// following points.
Interval *TimeInterval `protobuf:"bytes,1,opt,name=interval" json:"interval,omitempty"`
// The value of the data point.
Value *TypedValue `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}
func (*Point) Descriptor ¶
func (*Point) Descriptor() ([]byte, []int)
func (*Point) GetInterval ¶
func (m *Point) GetInterval() *TimeInterval
func (*Point) GetValue ¶
func (m *Point) GetValue() *TypedValue
func (*Point) ProtoMessage ¶
func (*Point) ProtoMessage()
func (*Point) Reset ¶
func (m *Point) Reset()
func (*Point) String ¶
func (m *Point) String() string
type TimeInterval ¶
A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.
type TimeInterval struct {
// Required. The end of the time interval.
EndTime *google_protobuf2.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime" json:"end_time,omitempty"`
// Optional. The beginning of the time interval. The default value
// for the start time is the end time. The start time must not be
// later than the end time.
StartTime *google_protobuf2.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime" json:"start_time,omitempty"`
}
func (*TimeInterval) Descriptor ¶
func (*TimeInterval) Descriptor() ([]byte, []int)
func (*TimeInterval) GetEndTime ¶
func (m *TimeInterval) GetEndTime() *google_protobuf2.Timestamp
func (*TimeInterval) GetStartTime ¶
func (m *TimeInterval) GetStartTime() *google_protobuf2.Timestamp
func (*TimeInterval) ProtoMessage ¶
func (*TimeInterval) ProtoMessage()
func (*TimeInterval) Reset ¶
func (m *TimeInterval) Reset()
func (*TimeInterval) String ¶
func (m *TimeInterval) String() string
type TimeSeries ¶
A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.
type TimeSeries struct {
// The associated metric. A fully-specified metric used to identify the time
// series.
Metric *google_api5.Metric `protobuf:"bytes,1,opt,name=metric" json:"metric,omitempty"`
// The associated resource. A fully-specified monitored resource used to
// identify the time series.
Resource *google_api4.MonitoredResource `protobuf:"bytes,2,opt,name=resource" json:"resource,omitempty"`
// The metric kind of the time series. When listing time series, this metric
// kind might be different from the metric kind of the associated metric if
// this time series is an alignment or reduction of other time series.
//
// When creating a time series, this field is optional. If present, it must be
// the same as the metric kind of the associated metric. If the associated
// metric's descriptor must be auto-created, then this field specifies the
// metric kind of the new descriptor and must be either `GAUGE` (the default)
// or `CUMULATIVE`.
MetricKind google_api5.MetricDescriptor_MetricKind `protobuf:"varint,3,opt,name=metric_kind,json=metricKind,enum=google.api.MetricDescriptor_MetricKind" json:"metric_kind,omitempty"`
// The value type of the time series. When listing time series, this value
// type might be different from the value type of the associated metric if
// this time series is an alignment or reduction of other time series.
//
// When creating a time series, this field is optional. If present, it must be
// the same as the type of the data in the `points` field.
ValueType google_api5.MetricDescriptor_ValueType `protobuf:"varint,4,opt,name=value_type,json=valueType,enum=google.api.MetricDescriptor_ValueType" json:"value_type,omitempty"`
// The data points of this time series. When listing time series, the order of
// the points is specified by the list method.
//
// When creating a time series, this field must contain exactly one point and
// the point's type must be the same as the value type of the associated
// metric. If the associated metric's descriptor must be auto-created, then
// the value type of the descriptor is determined by the point's type, which
// must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
Points []*Point `protobuf:"bytes,5,rep,name=points" json:"points,omitempty"`
}
func (*TimeSeries) Descriptor ¶
func (*TimeSeries) Descriptor() ([]byte, []int)
func (*TimeSeries) GetMetric ¶
func (m *TimeSeries) GetMetric() *google_api5.Metric
func (*TimeSeries) GetMetricKind ¶
func (m *TimeSeries) GetMetricKind() google_api5.MetricDescriptor_MetricKind
func (*TimeSeries) GetPoints ¶
func (m *TimeSeries) GetPoints() []*Point
func (*TimeSeries) GetResource ¶
func (m *TimeSeries) GetResource() *google_api4.MonitoredResource
func (*TimeSeries) GetValueType ¶
func (m *TimeSeries) GetValueType() google_api5.MetricDescriptor_ValueType
func (*TimeSeries) ProtoMessage ¶
func (*TimeSeries) ProtoMessage()
func (*TimeSeries) Reset ¶
func (m *TimeSeries) Reset()
func (*TimeSeries) String ¶
func (m *TimeSeries) String() string
type TypedValue ¶
A single strongly-typed value.
type TypedValue struct {
// The typed value field.
//
// Types that are valid to be assigned to Value:
// *TypedValue_BoolValue
// *TypedValue_Int64Value
// *TypedValue_DoubleValue
// *TypedValue_StringValue
// *TypedValue_DistributionValue
Value isTypedValue_Value `protobuf_oneof:"value"`
}
func (*TypedValue) Descriptor ¶
func (*TypedValue) Descriptor() ([]byte, []int)
func (*TypedValue) GetBoolValue ¶
func (m *TypedValue) GetBoolValue() bool
func (*TypedValue) GetDistributionValue ¶
func (m *TypedValue) GetDistributionValue() *google_api2.Distribution
func (*TypedValue) GetDoubleValue ¶
func (m *TypedValue) GetDoubleValue() float64
func (*TypedValue) GetInt64Value ¶
func (m *TypedValue) GetInt64Value() int64
func (*TypedValue) GetStringValue ¶
func (m *TypedValue) GetStringValue() string
func (*TypedValue) GetValue ¶
func (m *TypedValue) GetValue() isTypedValue_Value
func (*TypedValue) ProtoMessage ¶
func (*TypedValue) ProtoMessage()
func (*TypedValue) Reset ¶
func (m *TypedValue) Reset()
func (*TypedValue) String ¶
func (m *TypedValue) String() string
func (*TypedValue) XXX_OneofFuncs ¶
func (*TypedValue) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type TypedValue_BoolValue ¶
type TypedValue_BoolValue struct {
BoolValue bool `protobuf:"varint,1,opt,name=bool_value,json=boolValue,oneof"`
}
type TypedValue_DistributionValue ¶
type TypedValue_DistributionValue struct {
DistributionValue *google_api2.Distribution `protobuf:"bytes,5,opt,name=distribution_value,json=distributionValue,oneof"`
}
type TypedValue_DoubleValue ¶
type TypedValue_DoubleValue struct {
DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,oneof"`
}
type TypedValue_Int64Value ¶
type TypedValue_Int64Value struct {
Int64Value int64 `protobuf:"varint,2,opt,name=int64_value,json=int64Value,oneof"`
}
type TypedValue_StringValue ¶
type TypedValue_StringValue struct {
StringValue string `protobuf:"bytes,4,opt,name=string_value,json=stringValue,oneof"`
}
type UpdateGroupRequest ¶
The `UpdateGroup` request.
type UpdateGroupRequest struct {
// The new definition of the group. All fields of the existing group,
// excepting `name`, are replaced with the corresponding fields of this group.
Group *Group `protobuf:"bytes,2,opt,name=group" json:"group,omitempty"`
// If true, validate this request but do not update the existing group.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly" json:"validate_only,omitempty"`
}
func (*UpdateGroupRequest) Descriptor ¶
func (*UpdateGroupRequest) Descriptor() ([]byte, []int)
func (*UpdateGroupRequest) GetGroup ¶
func (m *UpdateGroupRequest) GetGroup() *Group
func (*UpdateGroupRequest) GetValidateOnly ¶
func (m *UpdateGroupRequest) GetValidateOnly() bool
func (*UpdateGroupRequest) ProtoMessage ¶
func (*UpdateGroupRequest) ProtoMessage()
func (*UpdateGroupRequest) Reset ¶
func (m *UpdateGroupRequest) Reset()
func (*UpdateGroupRequest) String ¶
func (m *UpdateGroupRequest) String() string
ActiveGo 1.8