Documentation ¶
Overview ¶
Package monitoring provides access to the Google Monitoring API.
See https://cloud.google.com/monitoring/api/
Usage example:
import "google.golang.org/api/monitoring/v3" ... monitoringService, err := monitoring.New(oauthHttpClient)
Index ¶
- Constants
- type BucketOptions
- type CollectdPayload
- type CollectdValue
- type CreateCollectdTimeSeriesRequest
- type CreateTimeSeriesRequest
- type Distribution
- type Empty
- type Explicit
- type Exponential
- type Field
- type Group
- type LabelDescriptor
- type Linear
- type ListGroupMembersResponse
- type ListGroupsResponse
- type ListMetricDescriptorsResponse
- type ListMonitoredResourceDescriptorsResponse
- type ListTimeSeriesResponse
- type Metric
- type MetricDescriptor
- type MonitoredResource
- type MonitoredResourceDescriptor
- type Option
- type OptionValue
- type Point
- type ProjectsCollectdTimeSeriesCreateCall
- func (c *ProjectsCollectdTimeSeriesCreateCall) Context(ctx context.Context) *ProjectsCollectdTimeSeriesCreateCall
- func (c *ProjectsCollectdTimeSeriesCreateCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsCollectdTimeSeriesCreateCall) Fields(s ...googleapi.Field) *ProjectsCollectdTimeSeriesCreateCall
- type ProjectsCollectdTimeSeriesService
- type ProjectsGroupsCreateCall
- func (c *ProjectsGroupsCreateCall) Context(ctx context.Context) *ProjectsGroupsCreateCall
- func (c *ProjectsGroupsCreateCall) Do(opts ...googleapi.CallOption) (*Group, error)
- func (c *ProjectsGroupsCreateCall) Fields(s ...googleapi.Field) *ProjectsGroupsCreateCall
- func (c *ProjectsGroupsCreateCall) ValidateOnly(validateOnly bool) *ProjectsGroupsCreateCall
- type ProjectsGroupsDeleteCall
- type ProjectsGroupsGetCall
- func (c *ProjectsGroupsGetCall) Context(ctx context.Context) *ProjectsGroupsGetCall
- func (c *ProjectsGroupsGetCall) Do(opts ...googleapi.CallOption) (*Group, error)
- func (c *ProjectsGroupsGetCall) Fields(s ...googleapi.Field) *ProjectsGroupsGetCall
- func (c *ProjectsGroupsGetCall) IfNoneMatch(entityTag string) *ProjectsGroupsGetCall
- type ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) AncestorsOfGroup(ancestorsOfGroup string) *ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) ChildrenOfGroup(childrenOfGroup string) *ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) Context(ctx context.Context) *ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) DescendantsOfGroup(descendantsOfGroup string) *ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) Do(opts ...googleapi.CallOption) (*ListGroupsResponse, error)
- func (c *ProjectsGroupsListCall) Fields(s ...googleapi.Field) *ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) IfNoneMatch(entityTag string) *ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) PageSize(pageSize int64) *ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) PageToken(pageToken string) *ProjectsGroupsListCall
- func (c *ProjectsGroupsListCall) Pages(ctx context.Context, f func(*ListGroupsResponse) error) error
- type ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) Context(ctx context.Context) *ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) Do(opts ...googleapi.CallOption) (*ListGroupMembersResponse, error)
- func (c *ProjectsGroupsMembersListCall) Fields(s ...googleapi.Field) *ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) Filter(filter string) *ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) IfNoneMatch(entityTag string) *ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) IntervalEndTime(intervalEndTime string) *ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) IntervalStartTime(intervalStartTime string) *ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) PageSize(pageSize int64) *ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) PageToken(pageToken string) *ProjectsGroupsMembersListCall
- func (c *ProjectsGroupsMembersListCall) Pages(ctx context.Context, f func(*ListGroupMembersResponse) error) error
- type ProjectsGroupsMembersService
- type ProjectsGroupsService
- func (r *ProjectsGroupsService) Create(name string, group *Group) *ProjectsGroupsCreateCall
- func (r *ProjectsGroupsService) Delete(name string) *ProjectsGroupsDeleteCall
- func (r *ProjectsGroupsService) Get(name string) *ProjectsGroupsGetCall
- func (r *ProjectsGroupsService) List(name string) *ProjectsGroupsListCall
- func (r *ProjectsGroupsService) Update(name string, group *Group) *ProjectsGroupsUpdateCall
- type ProjectsGroupsUpdateCall
- func (c *ProjectsGroupsUpdateCall) Context(ctx context.Context) *ProjectsGroupsUpdateCall
- func (c *ProjectsGroupsUpdateCall) Do(opts ...googleapi.CallOption) (*Group, error)
- func (c *ProjectsGroupsUpdateCall) Fields(s ...googleapi.Field) *ProjectsGroupsUpdateCall
- func (c *ProjectsGroupsUpdateCall) ValidateOnly(validateOnly bool) *ProjectsGroupsUpdateCall
- type ProjectsMetricDescriptorsCreateCall
- func (c *ProjectsMetricDescriptorsCreateCall) Context(ctx context.Context) *ProjectsMetricDescriptorsCreateCall
- func (c *ProjectsMetricDescriptorsCreateCall) Do(opts ...googleapi.CallOption) (*MetricDescriptor, error)
- func (c *ProjectsMetricDescriptorsCreateCall) Fields(s ...googleapi.Field) *ProjectsMetricDescriptorsCreateCall
- type ProjectsMetricDescriptorsDeleteCall
- func (c *ProjectsMetricDescriptorsDeleteCall) Context(ctx context.Context) *ProjectsMetricDescriptorsDeleteCall
- func (c *ProjectsMetricDescriptorsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsMetricDescriptorsDeleteCall) Fields(s ...googleapi.Field) *ProjectsMetricDescriptorsDeleteCall
- type ProjectsMetricDescriptorsGetCall
- func (c *ProjectsMetricDescriptorsGetCall) Context(ctx context.Context) *ProjectsMetricDescriptorsGetCall
- func (c *ProjectsMetricDescriptorsGetCall) Do(opts ...googleapi.CallOption) (*MetricDescriptor, error)
- func (c *ProjectsMetricDescriptorsGetCall) Fields(s ...googleapi.Field) *ProjectsMetricDescriptorsGetCall
- func (c *ProjectsMetricDescriptorsGetCall) IfNoneMatch(entityTag string) *ProjectsMetricDescriptorsGetCall
- type ProjectsMetricDescriptorsListCall
- func (c *ProjectsMetricDescriptorsListCall) Context(ctx context.Context) *ProjectsMetricDescriptorsListCall
- func (c *ProjectsMetricDescriptorsListCall) Do(opts ...googleapi.CallOption) (*ListMetricDescriptorsResponse, error)
- func (c *ProjectsMetricDescriptorsListCall) Fields(s ...googleapi.Field) *ProjectsMetricDescriptorsListCall
- func (c *ProjectsMetricDescriptorsListCall) Filter(filter string) *ProjectsMetricDescriptorsListCall
- func (c *ProjectsMetricDescriptorsListCall) IfNoneMatch(entityTag string) *ProjectsMetricDescriptorsListCall
- func (c *ProjectsMetricDescriptorsListCall) PageSize(pageSize int64) *ProjectsMetricDescriptorsListCall
- func (c *ProjectsMetricDescriptorsListCall) PageToken(pageToken string) *ProjectsMetricDescriptorsListCall
- func (c *ProjectsMetricDescriptorsListCall) Pages(ctx context.Context, f func(*ListMetricDescriptorsResponse) error) error
- type ProjectsMetricDescriptorsService
- func (r *ProjectsMetricDescriptorsService) Create(name string, metricdescriptor *MetricDescriptor) *ProjectsMetricDescriptorsCreateCall
- func (r *ProjectsMetricDescriptorsService) Delete(name string) *ProjectsMetricDescriptorsDeleteCall
- func (r *ProjectsMetricDescriptorsService) Get(name string) *ProjectsMetricDescriptorsGetCall
- func (r *ProjectsMetricDescriptorsService) List(name string) *ProjectsMetricDescriptorsListCall
- type ProjectsMonitoredResourceDescriptorsGetCall
- func (c *ProjectsMonitoredResourceDescriptorsGetCall) Context(ctx context.Context) *ProjectsMonitoredResourceDescriptorsGetCall
- func (c *ProjectsMonitoredResourceDescriptorsGetCall) Do(opts ...googleapi.CallOption) (*MonitoredResourceDescriptor, error)
- func (c *ProjectsMonitoredResourceDescriptorsGetCall) Fields(s ...googleapi.Field) *ProjectsMonitoredResourceDescriptorsGetCall
- func (c *ProjectsMonitoredResourceDescriptorsGetCall) IfNoneMatch(entityTag string) *ProjectsMonitoredResourceDescriptorsGetCall
- type ProjectsMonitoredResourceDescriptorsListCall
- func (c *ProjectsMonitoredResourceDescriptorsListCall) Context(ctx context.Context) *ProjectsMonitoredResourceDescriptorsListCall
- func (c *ProjectsMonitoredResourceDescriptorsListCall) Do(opts ...googleapi.CallOption) (*ListMonitoredResourceDescriptorsResponse, error)
- func (c *ProjectsMonitoredResourceDescriptorsListCall) Fields(s ...googleapi.Field) *ProjectsMonitoredResourceDescriptorsListCall
- func (c *ProjectsMonitoredResourceDescriptorsListCall) Filter(filter string) *ProjectsMonitoredResourceDescriptorsListCall
- func (c *ProjectsMonitoredResourceDescriptorsListCall) IfNoneMatch(entityTag string) *ProjectsMonitoredResourceDescriptorsListCall
- func (c *ProjectsMonitoredResourceDescriptorsListCall) PageSize(pageSize int64) *ProjectsMonitoredResourceDescriptorsListCall
- func (c *ProjectsMonitoredResourceDescriptorsListCall) PageToken(pageToken string) *ProjectsMonitoredResourceDescriptorsListCall
- func (c *ProjectsMonitoredResourceDescriptorsListCall) Pages(ctx context.Context, f func(*ListMonitoredResourceDescriptorsResponse) error) error
- type ProjectsMonitoredResourceDescriptorsService
- type ProjectsService
- type ProjectsTimeSeriesCreateCall
- type ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) AggregationAlignmentPeriod(aggregationAlignmentPeriod string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) AggregationCrossSeriesReducer(aggregationCrossSeriesReducer string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) AggregationGroupByFields(aggregationGroupByFields ...string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) AggregationPerSeriesAligner(aggregationPerSeriesAligner string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) Context(ctx context.Context) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) Do(opts ...googleapi.CallOption) (*ListTimeSeriesResponse, error)
- func (c *ProjectsTimeSeriesListCall) Fields(s ...googleapi.Field) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) Filter(filter string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) IfNoneMatch(entityTag string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) IntervalEndTime(intervalEndTime string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) IntervalStartTime(intervalStartTime string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) OrderBy(orderBy string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) PageSize(pageSize int64) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) PageToken(pageToken string) *ProjectsTimeSeriesListCall
- func (c *ProjectsTimeSeriesListCall) Pages(ctx context.Context, f func(*ListTimeSeriesResponse) error) error
- func (c *ProjectsTimeSeriesListCall) View(view string) *ProjectsTimeSeriesListCall
- type ProjectsTimeSeriesService
- type Range
- type Service
- type SourceContext
- type TimeInterval
- type TimeSeries
- type Type
- type TypedValue
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // View and write monitoring data for all of your Google and third-party // Cloud and API projects MonitoringScope = "https://www.googleapis.com/auth/monitoring" // View monitoring data for all of your Google Cloud and third-party // projects MonitoringReadScope = "https://www.googleapis.com/auth/monitoring.read" // Publish metric data to your Google Cloud projects MonitoringWriteScope = "https://www.googleapis.com/auth/monitoring.write" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BucketOptions ¶
type BucketOptions struct { // ExplicitBuckets: The explicit buckets. ExplicitBuckets *Explicit `json:"explicitBuckets,omitempty"` // ExponentialBuckets: The exponential buckets. ExponentialBuckets *Exponential `json:"exponentialBuckets,omitempty"` // LinearBuckets: The linear bucket. LinearBuckets *Linear `json:"linearBuckets,omitempty"` // ForceSendFields is a list of field names (e.g. "ExplicitBuckets") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
BucketOptions: A Distribution may optionally contain a histogram of the values in the population. The histogram is given in `bucket_counts` as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by `bucket_options`. A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound. The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. `BucketOptions` describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly. If `bucket_boundaries` is not given, then no `bucket_counts` may be given.
func (*BucketOptions) MarshalJSON ¶
func (s *BucketOptions) MarshalJSON() ([]byte, error)
type CollectdPayload ¶
type CollectdPayload struct { // EndTime: The end time of the interval. EndTime string `json:"endTime,omitempty"` // Metadata: The measurement metadata. Example: "process_id" -> 12345` Metadata map[string]TypedValue `json:"metadata,omitempty"` // Plugin: The name of the plugin. Example: "disk". Plugin string `json:"plugin,omitempty"` // PluginInstance: The instance name of the plugin Example: "hdcl". PluginInstance string `json:"pluginInstance,omitempty"` // StartTime: The start time of the interval. StartTime string `json:"startTime,omitempty"` // Type: The measurement type. Example: "memory". Type string `json:"type,omitempty"` // TypeInstance: The measurement type instance. Example: "used". TypeInstance string `json:"typeInstance,omitempty"` // Values: The measured values during this time interval. Each value // must have a different `dataSourceName`. Values []*CollectdValue `json:"values,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CollectdPayload: A collection of data points sent from a `collectd`-based plugin. See the `collectd` documentation for more information.
func (*CollectdPayload) MarshalJSON ¶
func (s *CollectdPayload) MarshalJSON() ([]byte, error)
type CollectdValue ¶
type CollectdValue struct { // DataSourceName: The data source for the `collectd` value. For example // there are two data sources for network measurements: "rx" and // "tx". DataSourceName string `json:"dataSourceName,omitempty"` // DataSourceType: The type of measurement. // // Possible values: // "UNSPECIFIED_DATA_SOURCE_TYPE" // "GAUGE" // "COUNTER" // "DERIVE" // "ABSOLUTE" DataSourceType string `json:"dataSourceType,omitempty"` // Value: The measurement value. Value *TypedValue `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "DataSourceName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CollectdValue: A single data point from a `collectd`-based plugin.
func (*CollectdValue) MarshalJSON ¶
func (s *CollectdValue) MarshalJSON() ([]byte, error)
type CreateCollectdTimeSeriesRequest ¶
type CreateCollectdTimeSeriesRequest struct { // CollectdPayloads: The `collectd` payloads representing the time // series data. You must not include more than a single point for each // time series, so no two payloads can have the same values for all of // the fields `plugin`, `plugin_instance`, `type`, and `type_instance`. CollectdPayloads []*CollectdPayload `json:"collectdPayloads,omitempty"` // CollectdVersion: The version of `collectd` that collected the data. // Example: "5.3.0-192.el6". CollectdVersion string `json:"collectdVersion,omitempty"` // Resource: The monitored resource associated with the time series. Resource *MonitoredResource `json:"resource,omitempty"` // ForceSendFields is a list of field names (e.g. "CollectdPayloads") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CreateCollectdTimeSeriesRequest: The `CreateCollectdTimeSeries` request.
func (*CreateCollectdTimeSeriesRequest) MarshalJSON ¶
func (s *CreateCollectdTimeSeriesRequest) MarshalJSON() ([]byte, error)
type CreateTimeSeriesRequest ¶
type CreateTimeSeriesRequest struct { // TimeSeries: 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 `json:"timeSeries,omitempty"` // ForceSendFields is a list of field names (e.g. "TimeSeries") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CreateTimeSeriesRequest: The `CreateTimeSeries` request.
func (*CreateTimeSeriesRequest) MarshalJSON ¶
func (s *CreateTimeSeriesRequest) MarshalJSON() ([]byte, error)
type Distribution ¶
type Distribution struct { // BucketCounts: If `bucket_options` is given, then the sum of the // values in `bucket_counts` must equal the value in `count`. If // `bucket_options` is not given, no `bucket_counts` fields may be // given. Bucket counts are given in order under the numbering scheme // described above (the underflow bucket has number 0; the finite // buckets, if any, have numbers 1 through N-2; the overflow bucket has // number N-1). The size of `bucket_counts` must be no greater than N as // defined in `bucket_options`. Any suffix of trailing zero bucket_count // fields may be omitted. BucketCounts googleapi.Int64s `json:"bucketCounts,omitempty"` // BucketOptions: Defines the histogram bucket boundaries. BucketOptions *BucketOptions `json:"bucketOptions,omitempty"` // Count: The number of values in the population. Must be non-negative. Count int64 `json:"count,omitempty,string"` // Mean: The arithmetic mean of the values in the population. If `count` // is zero then this field must be zero. Mean float64 `json:"mean,omitempty"` // Range: If specified, contains the range of the population values. The // field must not be present if the `count` is zero. Range *Range `json:"range,omitempty"` // SumOfSquaredDeviation: The sum of squared deviations from the mean of // the values in the population. For values x_i this is: // Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", // Vol. 2, page 323, 3rd edition describes Welford's method for // accumulating this sum in one pass. If `count` is zero then this field // must be zero. SumOfSquaredDeviation float64 `json:"sumOfSquaredDeviation,omitempty"` // ForceSendFields is a list of field names (e.g. "BucketCounts") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Distribution: Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width). Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.
func (*Distribution) MarshalJSON ¶
func (s *Distribution) MarshalJSON() ([]byte, error)
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
type Explicit ¶
type Explicit struct { // Bounds: The values must be monotonically increasing. Bounds []float64 `json:"bounds,omitempty"` // ForceSendFields is a list of field names (e.g. "Bounds") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Explicit: A set of buckets with arbitrary widths. Defines `size(bounds) + 1` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] There must be at least one element in `bounds`. If `bounds` has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
func (*Explicit) MarshalJSON ¶
type Exponential ¶
type Exponential struct { // GrowthFactor: Must be greater than 1 GrowthFactor float64 `json:"growthFactor,omitempty"` // NumFiniteBuckets: must be greater than 0 NumFiniteBuckets int64 `json:"numFiniteBuckets,omitempty"` // Scale: Must be greater than 0 Scale float64 `json:"scale,omitempty"` // ForceSendFields is a list of field names (e.g. "GrowthFactor") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Exponential: Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket i: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
func (*Exponential) MarshalJSON ¶
func (s *Exponential) MarshalJSON() ([]byte, error)
type Field ¶
type Field struct { // Cardinality: The field cardinality. // // Possible values: // "CARDINALITY_UNKNOWN" // "CARDINALITY_OPTIONAL" // "CARDINALITY_REQUIRED" // "CARDINALITY_REPEATED" Cardinality string `json:"cardinality,omitempty"` // DefaultValue: The string value of the default value of this field. // Proto2 syntax only. DefaultValue string `json:"defaultValue,omitempty"` // JsonName: The field JSON name. JsonName string `json:"jsonName,omitempty"` // Kind: The field type. // // Possible values: // "TYPE_UNKNOWN" // "TYPE_DOUBLE" // "TYPE_FLOAT" // "TYPE_INT64" // "TYPE_UINT64" // "TYPE_INT32" // "TYPE_FIXED64" // "TYPE_FIXED32" // "TYPE_BOOL" // "TYPE_STRING" // "TYPE_GROUP" // "TYPE_MESSAGE" // "TYPE_BYTES" // "TYPE_UINT32" // "TYPE_ENUM" // "TYPE_SFIXED32" // "TYPE_SFIXED64" // "TYPE_SINT32" // "TYPE_SINT64" Kind string `json:"kind,omitempty"` // Name: The field name. Name string `json:"name,omitempty"` // Number: The field number. Number int64 `json:"number,omitempty"` // OneofIndex: The index of the field type in `Type.oneofs`, for message // or enumeration types. The first type has index 1; zero means the type // is not in the list. OneofIndex int64 `json:"oneofIndex,omitempty"` // Options: The protocol buffer options. Options []*Option `json:"options,omitempty"` // Packed: Whether to use alternative packed wire representation. Packed bool `json:"packed,omitempty"` // TypeUrl: The field type URL, without the scheme, for message or // enumeration types. Example: // "type.googleapis.com/google.protobuf.Timestamp". TypeUrl string `json:"typeUrl,omitempty"` // ForceSendFields is a list of field names (e.g. "Cardinality") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Field: A single field of a message type.
func (*Field) MarshalJSON ¶
type Group ¶
type Group struct { // DisplayName: A user-assigned name for this group, used only for // display purposes. DisplayName string `json:"displayName,omitempty"` // Filter: The filter used to determine which monitored resources belong // to this group. Filter string `json:"filter,omitempty"` // IsCluster: 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 `json:"isCluster,omitempty"` // Name: 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. @OutputOnly Name string `json:"name,omitempty"` // ParentName: 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 `json:"parentName,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "DisplayName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
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.
func (*Group) MarshalJSON ¶
type LabelDescriptor ¶
type LabelDescriptor struct { // Description: A human-readable description for the label. Description string `json:"description,omitempty"` // Key: The label key. Key string `json:"key,omitempty"` // ValueType: The type of data that can be assigned to the label. // // Possible values: // "STRING" // "BOOL" // "INT64" ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
LabelDescriptor: A description of a label.
func (*LabelDescriptor) MarshalJSON ¶
func (s *LabelDescriptor) MarshalJSON() ([]byte, error)
type Linear ¶
type Linear struct { // NumFiniteBuckets: Must be greater than 0. NumFiniteBuckets int64 `json:"numFiniteBuckets,omitempty"` // Offset: Lower bound of the first bucket. Offset float64 `json:"offset,omitempty"` // Width: Must be greater than 0. Width float64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "NumFiniteBuckets") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Linear: Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket `i`: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).
func (*Linear) MarshalJSON ¶
type ListGroupMembersResponse ¶
type ListGroupMembersResponse struct { // Members: A set of monitored resources in the group. Members []*MonitoredResource `json:"members,omitempty"` // NextPageToken: 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 `json:"nextPageToken,omitempty"` // TotalSize: The total number of elements matching this request. TotalSize int64 `json:"totalSize,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Members") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ListGroupMembersResponse: The `ListGroupMembers` response.
func (*ListGroupMembersResponse) MarshalJSON ¶
func (s *ListGroupMembersResponse) MarshalJSON() ([]byte, error)
type ListGroupsResponse ¶
type ListGroupsResponse struct { // Group: The groups that match the specified filters. Group []*Group `json:"group,omitempty"` // NextPageToken: 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 `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Group") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ListGroupsResponse: The `ListGroups` response.
func (*ListGroupsResponse) MarshalJSON ¶
func (s *ListGroupsResponse) MarshalJSON() ([]byte, error)
type ListMetricDescriptorsResponse ¶
type ListMetricDescriptorsResponse struct { // MetricDescriptors: The metric descriptors that are available to the // project and that match the value of `filter`, if present. MetricDescriptors []*MetricDescriptor `json:"metricDescriptors,omitempty"` // NextPageToken: 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 `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "MetricDescriptors") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ListMetricDescriptorsResponse: The `ListMetricDescriptors` response.
func (*ListMetricDescriptorsResponse) MarshalJSON ¶
func (s *ListMetricDescriptorsResponse) MarshalJSON() ([]byte, error)
type ListMonitoredResourceDescriptorsResponse ¶
type ListMonitoredResourceDescriptorsResponse struct { // NextPageToken: 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 `json:"nextPageToken,omitempty"` // ResourceDescriptors: The monitored resource descriptors that are // available to this project and that match `filter`, if present. ResourceDescriptors []*MonitoredResourceDescriptor `json:"resourceDescriptors,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ListMonitoredResourceDescriptorsResponse: The `ListMonitoredResourcDescriptors` response.
func (*ListMonitoredResourceDescriptorsResponse) MarshalJSON ¶
func (s *ListMonitoredResourceDescriptorsResponse) MarshalJSON() ([]byte, error)
type ListTimeSeriesResponse ¶
type ListTimeSeriesResponse struct { // NextPageToken: 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 `json:"nextPageToken,omitempty"` // TimeSeries: One or more time series that match the filter included in // the request. TimeSeries []*TimeSeries `json:"timeSeries,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ListTimeSeriesResponse: The `ListTimeSeries` response.
func (*ListTimeSeriesResponse) MarshalJSON ¶
func (s *ListTimeSeriesResponse) MarshalJSON() ([]byte, error)
type Metric ¶
type Metric struct { // Labels: The set of labels that uniquely identify a metric. To specify // a metric, all labels enumerated in the `MetricDescriptor` must be // assigned values. Labels map[string]string `json:"labels,omitempty"` // Type: An existing metric type, see google.api.MetricDescriptor. For // example, `compute.googleapis.com/instance/cpu/usage_time`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Labels") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Metric: A specific metric identified by specifying values for all of the labels of a `MetricDescriptor`.
func (*Metric) MarshalJSON ¶
type MetricDescriptor ¶
type MetricDescriptor struct { // Description: A detailed description of the metric, which can be used // in documentation. Description string `json:"description,omitempty"` // DisplayName: A concise name for the metric, which can be displayed in // user interfaces. Use sentence case without an ending period, for // example "Request count". DisplayName string `json:"displayName,omitempty"` // Labels: The set of labels that can be used to describe a specific // instance of this metric type. For example, the // `compute.googleapis.com/instance/network/received_bytes_count` metric // type has a label, `loadbalanced`, that specifies whether the traffic // was received through a load balanced IP address. Labels []*LabelDescriptor `json:"labels,omitempty"` // MetricKind: Whether the metric records instantaneous values, changes // to a value, etc. // // Possible values: // "METRIC_KIND_UNSPECIFIED" // "GAUGE" // "DELTA" // "CUMULATIVE" MetricKind string `json:"metricKind,omitempty"` // Name: Resource name. The format of the name may vary between // different implementations. For examples: // projects/{project_id}/metricDescriptors/{type=**} // metricDescriptors/{type=**} Name string `json:"name,omitempty"` // Type: The metric type including a DNS name prefix, for example // "compute.googleapis.com/instance/cpu/utilization". Metric types // should use a natural hierarchical grouping such as the following: // compute.googleapis.com/instance/cpu/utilization // compute.googleapis.com/instance/disk/read_ops_count // compute.googleapis.com/instance/network/received_bytes_count Note // that if the metric type changes, the monitoring data will be // discontinued, and anything depends on it will break, such as // monitoring dashboards, alerting rules and quota limits. Therefore, // once a metric has been published, its type should be immutable. Type string `json:"type,omitempty"` // Unit: The unit in which the metric value is reported. It is only // applicable if the `value_type` is `INT64`, `DOUBLE`, or // `DISTRIBUTION`. The supported units are a subset of [The Unified Code // for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: // **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` // minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) // * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta // (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) // * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` // pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto // (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi // (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The // grammar includes the dimensionless unit `1`, such as `1/s`. The // grammar also includes these connectors: * `/` division (as an infix // operator, e.g. `1/s`). * `.` multiplication (as an infix operator, // e.g. `GBy.d`) The grammar for a unit is as follows: Expression = // Component { "." Component } { "/" Component } ; Component = [ PREFIX // ] UNIT [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" // ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and // is equivalent to `1` if it is used alone. For examples, `{requests}/s // == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of // non-blank printable ASCII characters not containing '{' or '}'. Unit string `json:"unit,omitempty"` // ValueType: Whether the measurement is an integer, a floating-point // number, etc. // // Possible values: // "VALUE_TYPE_UNSPECIFIED" // "BOOL" // "INT64" // "DOUBLE" // "STRING" // "DISTRIBUTION" // "MONEY" ValueType string `json:"valueType,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MetricDescriptor: Defines a metric type and its schema.
func (*MetricDescriptor) MarshalJSON ¶
func (s *MetricDescriptor) MarshalJSON() ([]byte, error)
type MonitoredResource ¶
type MonitoredResource struct { // Labels: Required. Values for all of the labels listed in the // associated monitored resource descriptor. For example, Cloud SQL // databases use the labels "database_id" and "zone". Labels map[string]string `json:"labels,omitempty"` // Type: Required. The monitored resource type. This field must match // the `type` field of a MonitoredResourceDescriptor object. For // example, the type of a Cloud SQL database is "cloudsql_database". Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Labels") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MonitoredResource: 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 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 for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "my-instance", "zone": "us-central1-a" }}
func (*MonitoredResource) MarshalJSON ¶
func (s *MonitoredResource) MarshalJSON() ([]byte, error)
type MonitoredResourceDescriptor ¶
type MonitoredResourceDescriptor struct { // Description: Optional. A detailed description of the monitored // resource type that might be used in documentation. Description string `json:"description,omitempty"` // DisplayName: Optional. A concise name for the monitored resource type // that might be displayed in user interfaces. For example, "Google // Cloud SQL Database". DisplayName string `json:"displayName,omitempty"` // Labels: Required. A set of labels used to describe instances of this // monitored resource type. For example, an individual Google Cloud SQL // database is identified by values for the labels "database_id" and // "zone". Labels []*LabelDescriptor `json:"labels,omitempty"` // Name: Optional. The resource name of the monitored resource // descriptor: // "projects/{project_id}/monitoredResourceDescriptors/{type}" where // {type} is the value of the `type` field in this object and // {project_id} is a project ID that provides API-specific context for // accessing the type. APIs that do not use project information can use // the resource name format "monitoredResourceDescriptors/{type}". Name string `json:"name,omitempty"` // Type: Required. The monitored resource type. For example, the type // "cloudsql_database" represents databases in Google Cloud SQL. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MonitoredResourceDescriptor: An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.
func (*MonitoredResourceDescriptor) MarshalJSON ¶
func (s *MonitoredResourceDescriptor) MarshalJSON() ([]byte, error)
type Option ¶
type Option struct { // Name: The option's name. For example, "java_package". Name string `json:"name,omitempty"` // Value: The option's value. For example, "com.google.protobuf". Value OptionValue `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Option: A protocol buffer option, which can be attached to a message, field, enumeration, etc.
func (*Option) MarshalJSON ¶
type OptionValue ¶
type OptionValue interface{}
type Point ¶
type Point struct { // Interval: The time interval to which the value applies. Interval *TimeInterval `json:"interval,omitempty"` // Value: The value of the data point. Value *TypedValue `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Interval") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Point: A single data point in a time series.
func (*Point) MarshalJSON ¶
type ProjectsCollectdTimeSeriesCreateCall ¶
type ProjectsCollectdTimeSeriesCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsCollectdTimeSeriesCreateCall) Context ¶
func (c *ProjectsCollectdTimeSeriesCreateCall) Context(ctx context.Context) *ProjectsCollectdTimeSeriesCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsCollectdTimeSeriesCreateCall) Do ¶
func (c *ProjectsCollectdTimeSeriesCreateCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "monitoring.projects.collectdTimeSeries.create" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsCollectdTimeSeriesCreateCall) Fields ¶
func (c *ProjectsCollectdTimeSeriesCreateCall) Fields(s ...googleapi.Field) *ProjectsCollectdTimeSeriesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsCollectdTimeSeriesService ¶
type ProjectsCollectdTimeSeriesService struct {
// contains filtered or unexported fields
}
func NewProjectsCollectdTimeSeriesService ¶
func NewProjectsCollectdTimeSeriesService(s *Service) *ProjectsCollectdTimeSeriesService
func (*ProjectsCollectdTimeSeriesService) Create ¶
func (r *ProjectsCollectdTimeSeriesService) Create(name string, createcollectdtimeseriesrequest *CreateCollectdTimeSeriesRequest) *ProjectsCollectdTimeSeriesCreateCall
Create: Creates a new time series with the given data points. This method is only for use in `collectd`-related code, including the Google Monitoring Agent. See [google.monitoring.v3.MetricService.CreateTimeSeries] instead.
type ProjectsGroupsCreateCall ¶
type ProjectsGroupsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGroupsCreateCall) Context ¶
func (c *ProjectsGroupsCreateCall) Context(ctx context.Context) *ProjectsGroupsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsGroupsCreateCall) Do ¶
func (c *ProjectsGroupsCreateCall) Do(opts ...googleapi.CallOption) (*Group, error)
Do executes the "monitoring.projects.groups.create" call. Exactly one of *Group or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Group.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsGroupsCreateCall) Fields ¶
func (c *ProjectsGroupsCreateCall) Fields(s ...googleapi.Field) *ProjectsGroupsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsGroupsCreateCall) ValidateOnly ¶
func (c *ProjectsGroupsCreateCall) ValidateOnly(validateOnly bool) *ProjectsGroupsCreateCall
ValidateOnly sets the optional parameter "validateOnly": If true, validate this request but do not create the group.
type ProjectsGroupsDeleteCall ¶
type ProjectsGroupsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGroupsDeleteCall) Context ¶
func (c *ProjectsGroupsDeleteCall) Context(ctx context.Context) *ProjectsGroupsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsGroupsDeleteCall) Do ¶
func (c *ProjectsGroupsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "monitoring.projects.groups.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsGroupsDeleteCall) Fields ¶
func (c *ProjectsGroupsDeleteCall) Fields(s ...googleapi.Field) *ProjectsGroupsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsGroupsGetCall ¶
type ProjectsGroupsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGroupsGetCall) Context ¶
func (c *ProjectsGroupsGetCall) Context(ctx context.Context) *ProjectsGroupsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsGroupsGetCall) Do ¶
func (c *ProjectsGroupsGetCall) Do(opts ...googleapi.CallOption) (*Group, error)
Do executes the "monitoring.projects.groups.get" call. Exactly one of *Group or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Group.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsGroupsGetCall) Fields ¶
func (c *ProjectsGroupsGetCall) Fields(s ...googleapi.Field) *ProjectsGroupsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsGroupsGetCall) IfNoneMatch ¶
func (c *ProjectsGroupsGetCall) IfNoneMatch(entityTag string) *ProjectsGroupsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsGroupsListCall ¶
type ProjectsGroupsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGroupsListCall) AncestorsOfGroup ¶
func (c *ProjectsGroupsListCall) AncestorsOfGroup(ancestorsOfGroup string) *ProjectsGroupsListCall
AncestorsOfGroup sets the optional parameter "ancestorsOfGroup": A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
func (*ProjectsGroupsListCall) ChildrenOfGroup ¶
func (c *ProjectsGroupsListCall) ChildrenOfGroup(childrenOfGroup string) *ProjectsGroupsListCall
ChildrenOfGroup sets the optional parameter "childrenOfGroup": A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose `parentName` field contains the group name. If no groups have this parent, the results are empty.
func (*ProjectsGroupsListCall) Context ¶
func (c *ProjectsGroupsListCall) Context(ctx context.Context) *ProjectsGroupsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsGroupsListCall) DescendantsOfGroup ¶
func (c *ProjectsGroupsListCall) DescendantsOfGroup(descendantsOfGroup string) *ProjectsGroupsListCall
DescendantsOfGroup sets the optional parameter "descendantsOfGroup": A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the `childrenOfGroup` filter, and includes children-of-children, and so forth.
func (*ProjectsGroupsListCall) Do ¶
func (c *ProjectsGroupsListCall) Do(opts ...googleapi.CallOption) (*ListGroupsResponse, error)
Do executes the "monitoring.projects.groups.list" call. Exactly one of *ListGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListGroupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsGroupsListCall) Fields ¶
func (c *ProjectsGroupsListCall) Fields(s ...googleapi.Field) *ProjectsGroupsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsGroupsListCall) IfNoneMatch ¶
func (c *ProjectsGroupsListCall) IfNoneMatch(entityTag string) *ProjectsGroupsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsGroupsListCall) PageSize ¶
func (c *ProjectsGroupsListCall) PageSize(pageSize int64) *ProjectsGroupsListCall
PageSize sets the optional parameter "pageSize": A positive number that is the maximum number of results to return.
func (*ProjectsGroupsListCall) PageToken ¶
func (c *ProjectsGroupsListCall) PageToken(pageToken string) *ProjectsGroupsListCall
PageToken sets the optional parameter "pageToken": 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.
func (*ProjectsGroupsListCall) Pages ¶
func (c *ProjectsGroupsListCall) Pages(ctx context.Context, f func(*ListGroupsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsGroupsMembersListCall ¶
type ProjectsGroupsMembersListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGroupsMembersListCall) Context ¶
func (c *ProjectsGroupsMembersListCall) Context(ctx context.Context) *ProjectsGroupsMembersListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsGroupsMembersListCall) Do ¶
func (c *ProjectsGroupsMembersListCall) Do(opts ...googleapi.CallOption) (*ListGroupMembersResponse, error)
Do executes the "monitoring.projects.groups.members.list" call. Exactly one of *ListGroupMembersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListGroupMembersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsGroupsMembersListCall) Fields ¶
func (c *ProjectsGroupsMembersListCall) Fields(s ...googleapi.Field) *ProjectsGroupsMembersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsGroupsMembersListCall) Filter ¶
func (c *ProjectsGroupsMembersListCall) Filter(filter string) *ProjectsGroupsMembersListCall
Filter sets the optional parameter "filter": 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"
func (*ProjectsGroupsMembersListCall) IfNoneMatch ¶
func (c *ProjectsGroupsMembersListCall) IfNoneMatch(entityTag string) *ProjectsGroupsMembersListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsGroupsMembersListCall) IntervalEndTime ¶
func (c *ProjectsGroupsMembersListCall) IntervalEndTime(intervalEndTime string) *ProjectsGroupsMembersListCall
IntervalEndTime sets the optional parameter "interval.endTime": Required. The end of the interval. The interval includes this time.
func (*ProjectsGroupsMembersListCall) IntervalStartTime ¶
func (c *ProjectsGroupsMembersListCall) IntervalStartTime(intervalStartTime string) *ProjectsGroupsMembersListCall
IntervalStartTime sets the optional parameter "interval.startTime": If this value is omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.
func (*ProjectsGroupsMembersListCall) PageSize ¶
func (c *ProjectsGroupsMembersListCall) PageSize(pageSize int64) *ProjectsGroupsMembersListCall
PageSize sets the optional parameter "pageSize": A positive number that is the maximum number of results to return.
func (*ProjectsGroupsMembersListCall) PageToken ¶
func (c *ProjectsGroupsMembersListCall) PageToken(pageToken string) *ProjectsGroupsMembersListCall
PageToken sets the optional parameter "pageToken": 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.
func (*ProjectsGroupsMembersListCall) Pages ¶
func (c *ProjectsGroupsMembersListCall) Pages(ctx context.Context, f func(*ListGroupMembersResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsGroupsMembersService ¶
type ProjectsGroupsMembersService struct {
// contains filtered or unexported fields
}
func NewProjectsGroupsMembersService ¶
func NewProjectsGroupsMembersService(s *Service) *ProjectsGroupsMembersService
func (*ProjectsGroupsMembersService) List ¶
func (r *ProjectsGroupsMembersService) List(name string) *ProjectsGroupsMembersListCall
List: Lists the monitored resources that are members of a group.
type ProjectsGroupsService ¶
type ProjectsGroupsService struct { Members *ProjectsGroupsMembersService // contains filtered or unexported fields }
func NewProjectsGroupsService ¶
func NewProjectsGroupsService(s *Service) *ProjectsGroupsService
func (*ProjectsGroupsService) Create ¶
func (r *ProjectsGroupsService) Create(name string, group *Group) *ProjectsGroupsCreateCall
Create: Creates a new group.
func (*ProjectsGroupsService) Delete ¶
func (r *ProjectsGroupsService) Delete(name string) *ProjectsGroupsDeleteCall
Delete: Deletes an existing group.
func (*ProjectsGroupsService) Get ¶
func (r *ProjectsGroupsService) Get(name string) *ProjectsGroupsGetCall
Get: Gets a single group.
func (*ProjectsGroupsService) List ¶
func (r *ProjectsGroupsService) List(name string) *ProjectsGroupsListCall
List: Lists the existing groups.
func (*ProjectsGroupsService) Update ¶
func (r *ProjectsGroupsService) Update(name string, group *Group) *ProjectsGroupsUpdateCall
Update: Updates an existing group. You can change any group attributes except `name`.
type ProjectsGroupsUpdateCall ¶
type ProjectsGroupsUpdateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGroupsUpdateCall) Context ¶
func (c *ProjectsGroupsUpdateCall) Context(ctx context.Context) *ProjectsGroupsUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsGroupsUpdateCall) Do ¶
func (c *ProjectsGroupsUpdateCall) Do(opts ...googleapi.CallOption) (*Group, error)
Do executes the "monitoring.projects.groups.update" call. Exactly one of *Group or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Group.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsGroupsUpdateCall) Fields ¶
func (c *ProjectsGroupsUpdateCall) Fields(s ...googleapi.Field) *ProjectsGroupsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsGroupsUpdateCall) ValidateOnly ¶
func (c *ProjectsGroupsUpdateCall) ValidateOnly(validateOnly bool) *ProjectsGroupsUpdateCall
ValidateOnly sets the optional parameter "validateOnly": If true, validate this request but do not update the existing group.
type ProjectsMetricDescriptorsCreateCall ¶
type ProjectsMetricDescriptorsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsMetricDescriptorsCreateCall) Context ¶
func (c *ProjectsMetricDescriptorsCreateCall) Context(ctx context.Context) *ProjectsMetricDescriptorsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsMetricDescriptorsCreateCall) Do ¶
func (c *ProjectsMetricDescriptorsCreateCall) Do(opts ...googleapi.CallOption) (*MetricDescriptor, error)
Do executes the "monitoring.projects.metricDescriptors.create" call. Exactly one of *MetricDescriptor or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *MetricDescriptor.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsMetricDescriptorsCreateCall) Fields ¶
func (c *ProjectsMetricDescriptorsCreateCall) Fields(s ...googleapi.Field) *ProjectsMetricDescriptorsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsMetricDescriptorsDeleteCall ¶
type ProjectsMetricDescriptorsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsMetricDescriptorsDeleteCall) Context ¶
func (c *ProjectsMetricDescriptorsDeleteCall) Context(ctx context.Context) *ProjectsMetricDescriptorsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsMetricDescriptorsDeleteCall) Do ¶
func (c *ProjectsMetricDescriptorsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "monitoring.projects.metricDescriptors.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsMetricDescriptorsDeleteCall) Fields ¶
func (c *ProjectsMetricDescriptorsDeleteCall) Fields(s ...googleapi.Field) *ProjectsMetricDescriptorsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsMetricDescriptorsGetCall ¶
type ProjectsMetricDescriptorsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsMetricDescriptorsGetCall) Context ¶
func (c *ProjectsMetricDescriptorsGetCall) Context(ctx context.Context) *ProjectsMetricDescriptorsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsMetricDescriptorsGetCall) Do ¶
func (c *ProjectsMetricDescriptorsGetCall) Do(opts ...googleapi.CallOption) (*MetricDescriptor, error)
Do executes the "monitoring.projects.metricDescriptors.get" call. Exactly one of *MetricDescriptor or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *MetricDescriptor.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsMetricDescriptorsGetCall) Fields ¶
func (c *ProjectsMetricDescriptorsGetCall) Fields(s ...googleapi.Field) *ProjectsMetricDescriptorsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsMetricDescriptorsGetCall) IfNoneMatch ¶
func (c *ProjectsMetricDescriptorsGetCall) IfNoneMatch(entityTag string) *ProjectsMetricDescriptorsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsMetricDescriptorsListCall ¶
type ProjectsMetricDescriptorsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsMetricDescriptorsListCall) Context ¶
func (c *ProjectsMetricDescriptorsListCall) Context(ctx context.Context) *ProjectsMetricDescriptorsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsMetricDescriptorsListCall) Do ¶
func (c *ProjectsMetricDescriptorsListCall) Do(opts ...googleapi.CallOption) (*ListMetricDescriptorsResponse, error)
Do executes the "monitoring.projects.metricDescriptors.list" call. Exactly one of *ListMetricDescriptorsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListMetricDescriptorsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsMetricDescriptorsListCall) Fields ¶
func (c *ProjectsMetricDescriptorsListCall) Fields(s ...googleapi.Field) *ProjectsMetricDescriptorsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsMetricDescriptorsListCall) Filter ¶
func (c *ProjectsMetricDescriptorsListCall) Filter(filter string) *ProjectsMetricDescriptorsListCall
Filter sets the optional parameter "filter": 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/")
func (*ProjectsMetricDescriptorsListCall) IfNoneMatch ¶
func (c *ProjectsMetricDescriptorsListCall) IfNoneMatch(entityTag string) *ProjectsMetricDescriptorsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsMetricDescriptorsListCall) PageSize ¶
func (c *ProjectsMetricDescriptorsListCall) PageSize(pageSize int64) *ProjectsMetricDescriptorsListCall
PageSize sets the optional parameter "pageSize": A positive number that is the maximum number of results to return.
func (*ProjectsMetricDescriptorsListCall) PageToken ¶
func (c *ProjectsMetricDescriptorsListCall) PageToken(pageToken string) *ProjectsMetricDescriptorsListCall
PageToken sets the optional parameter "pageToken": 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.
func (*ProjectsMetricDescriptorsListCall) Pages ¶
func (c *ProjectsMetricDescriptorsListCall) Pages(ctx context.Context, f func(*ListMetricDescriptorsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsMetricDescriptorsService ¶
type ProjectsMetricDescriptorsService struct {
// contains filtered or unexported fields
}
func NewProjectsMetricDescriptorsService ¶
func NewProjectsMetricDescriptorsService(s *Service) *ProjectsMetricDescriptorsService
func (*ProjectsMetricDescriptorsService) Create ¶
func (r *ProjectsMetricDescriptorsService) Create(name string, metricdescriptor *MetricDescriptor) *ProjectsMetricDescriptorsCreateCall
Create: Creates a new metric descriptor. User-created metric descriptors define [custom metrics](/monitoring/custom-metrics).
func (*ProjectsMetricDescriptorsService) Delete ¶
func (r *ProjectsMetricDescriptorsService) Delete(name string) *ProjectsMetricDescriptorsDeleteCall
Delete: Deletes a metric descriptor. Only user-created [custom metrics](/monitoring/custom-metrics) can be deleted.
func (*ProjectsMetricDescriptorsService) Get ¶
func (r *ProjectsMetricDescriptorsService) Get(name string) *ProjectsMetricDescriptorsGetCall
Get: Gets a single metric descriptor. This method does not require a Stackdriver account.
func (*ProjectsMetricDescriptorsService) List ¶
func (r *ProjectsMetricDescriptorsService) List(name string) *ProjectsMetricDescriptorsListCall
List: Lists metric descriptors that match a filter. This method does not require a Stackdriver account.
type ProjectsMonitoredResourceDescriptorsGetCall ¶
type ProjectsMonitoredResourceDescriptorsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsMonitoredResourceDescriptorsGetCall) Context ¶
func (c *ProjectsMonitoredResourceDescriptorsGetCall) Context(ctx context.Context) *ProjectsMonitoredResourceDescriptorsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsMonitoredResourceDescriptorsGetCall) Do ¶
func (c *ProjectsMonitoredResourceDescriptorsGetCall) Do(opts ...googleapi.CallOption) (*MonitoredResourceDescriptor, error)
Do executes the "monitoring.projects.monitoredResourceDescriptors.get" call. Exactly one of *MonitoredResourceDescriptor or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *MonitoredResourceDescriptor.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsMonitoredResourceDescriptorsGetCall) Fields ¶
func (c *ProjectsMonitoredResourceDescriptorsGetCall) Fields(s ...googleapi.Field) *ProjectsMonitoredResourceDescriptorsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsMonitoredResourceDescriptorsGetCall) IfNoneMatch ¶
func (c *ProjectsMonitoredResourceDescriptorsGetCall) IfNoneMatch(entityTag string) *ProjectsMonitoredResourceDescriptorsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsMonitoredResourceDescriptorsListCall ¶
type ProjectsMonitoredResourceDescriptorsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsMonitoredResourceDescriptorsListCall) Context ¶
func (c *ProjectsMonitoredResourceDescriptorsListCall) Context(ctx context.Context) *ProjectsMonitoredResourceDescriptorsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsMonitoredResourceDescriptorsListCall) Do ¶
func (c *ProjectsMonitoredResourceDescriptorsListCall) Do(opts ...googleapi.CallOption) (*ListMonitoredResourceDescriptorsResponse, error)
Do executes the "monitoring.projects.monitoredResourceDescriptors.list" call. Exactly one of *ListMonitoredResourceDescriptorsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListMonitoredResourceDescriptorsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsMonitoredResourceDescriptorsListCall) Fields ¶
func (c *ProjectsMonitoredResourceDescriptorsListCall) Fields(s ...googleapi.Field) *ProjectsMonitoredResourceDescriptorsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsMonitoredResourceDescriptorsListCall) Filter ¶
func (c *ProjectsMonitoredResourceDescriptorsListCall) Filter(filter string) *ProjectsMonitoredResourceDescriptorsListCall
Filter sets the optional parameter "filter": 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
func (*ProjectsMonitoredResourceDescriptorsListCall) IfNoneMatch ¶
func (c *ProjectsMonitoredResourceDescriptorsListCall) IfNoneMatch(entityTag string) *ProjectsMonitoredResourceDescriptorsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsMonitoredResourceDescriptorsListCall) PageSize ¶
func (c *ProjectsMonitoredResourceDescriptorsListCall) PageSize(pageSize int64) *ProjectsMonitoredResourceDescriptorsListCall
PageSize sets the optional parameter "pageSize": A positive number that is the maximum number of results to return.
func (*ProjectsMonitoredResourceDescriptorsListCall) PageToken ¶
func (c *ProjectsMonitoredResourceDescriptorsListCall) PageToken(pageToken string) *ProjectsMonitoredResourceDescriptorsListCall
PageToken sets the optional parameter "pageToken": 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.
func (*ProjectsMonitoredResourceDescriptorsListCall) Pages ¶
func (c *ProjectsMonitoredResourceDescriptorsListCall) Pages(ctx context.Context, f func(*ListMonitoredResourceDescriptorsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsMonitoredResourceDescriptorsService ¶
type ProjectsMonitoredResourceDescriptorsService struct {
// contains filtered or unexported fields
}
func NewProjectsMonitoredResourceDescriptorsService ¶
func NewProjectsMonitoredResourceDescriptorsService(s *Service) *ProjectsMonitoredResourceDescriptorsService
func (*ProjectsMonitoredResourceDescriptorsService) Get ¶
func (r *ProjectsMonitoredResourceDescriptorsService) Get(name string) *ProjectsMonitoredResourceDescriptorsGetCall
Get: Gets a single monitored resource descriptor. This method does not require a Stackdriver account.
func (*ProjectsMonitoredResourceDescriptorsService) List ¶
func (r *ProjectsMonitoredResourceDescriptorsService) List(name string) *ProjectsMonitoredResourceDescriptorsListCall
List: Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.
type ProjectsService ¶
type ProjectsService struct { CollectdTimeSeries *ProjectsCollectdTimeSeriesService Groups *ProjectsGroupsService MetricDescriptors *ProjectsMetricDescriptorsService MonitoredResourceDescriptors *ProjectsMonitoredResourceDescriptorsService TimeSeries *ProjectsTimeSeriesService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type ProjectsTimeSeriesCreateCall ¶
type ProjectsTimeSeriesCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTimeSeriesCreateCall) Context ¶
func (c *ProjectsTimeSeriesCreateCall) Context(ctx context.Context) *ProjectsTimeSeriesCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTimeSeriesCreateCall) Do ¶
func (c *ProjectsTimeSeriesCreateCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "monitoring.projects.timeSeries.create" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTimeSeriesCreateCall) Fields ¶
func (c *ProjectsTimeSeriesCreateCall) Fields(s ...googleapi.Field) *ProjectsTimeSeriesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsTimeSeriesListCall ¶
type ProjectsTimeSeriesListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTimeSeriesListCall) AggregationAlignmentPeriod ¶
func (c *ProjectsTimeSeriesListCall) AggregationAlignmentPeriod(aggregationAlignmentPeriod string) *ProjectsTimeSeriesListCall
AggregationAlignmentPeriod sets the optional parameter "aggregation.alignmentPeriod": The alignment period for per-[time series](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.
func (*ProjectsTimeSeriesListCall) AggregationCrossSeriesReducer ¶
func (c *ProjectsTimeSeriesListCall) AggregationCrossSeriesReducer(aggregationCrossSeriesReducer string) *ProjectsTimeSeriesListCall
AggregationCrossSeriesReducer sets the optional parameter "aggregation.crossSeriesReducer": 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.
Possible values:
"REDUCE_NONE" "REDUCE_MEAN" "REDUCE_MIN" "REDUCE_MAX" "REDUCE_SUM" "REDUCE_STDDEV" "REDUCE_COUNT" "REDUCE_COUNT_TRUE" "REDUCE_FRACTION_TRUE" "REDUCE_PERCENTILE_99" "REDUCE_PERCENTILE_95" "REDUCE_PERCENTILE_50" "REDUCE_PERCENTILE_05"
func (*ProjectsTimeSeriesListCall) AggregationGroupByFields ¶
func (c *ProjectsTimeSeriesListCall) AggregationGroupByFields(aggregationGroupByFields ...string) *ProjectsTimeSeriesListCall
AggregationGroupByFields sets the optional parameter "aggregation.groupByFields": 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. Fields not specified in `groupByFields` are aggregated away. If `groupByFields` is not specified, the time series are aggregated into a single output time series. If `crossSeriesReducer` is not defined, this field is ignored.
func (*ProjectsTimeSeriesListCall) AggregationPerSeriesAligner ¶
func (c *ProjectsTimeSeriesListCall) AggregationPerSeriesAligner(aggregationPerSeriesAligner string) *ProjectsTimeSeriesListCall
AggregationPerSeriesAligner sets the optional parameter "aggregation.perSeriesAligner": 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.
Possible values:
"ALIGN_NONE" "ALIGN_DELTA" "ALIGN_RATE" "ALIGN_INTERPOLATE" "ALIGN_NEXT_OLDER" "ALIGN_MIN" "ALIGN_MAX" "ALIGN_MEAN" "ALIGN_COUNT" "ALIGN_SUM" "ALIGN_STDDEV" "ALIGN_COUNT_TRUE" "ALIGN_FRACTION_TRUE"
func (*ProjectsTimeSeriesListCall) Context ¶
func (c *ProjectsTimeSeriesListCall) Context(ctx context.Context) *ProjectsTimeSeriesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTimeSeriesListCall) Do ¶
func (c *ProjectsTimeSeriesListCall) Do(opts ...googleapi.CallOption) (*ListTimeSeriesResponse, error)
Do executes the "monitoring.projects.timeSeries.list" call. Exactly one of *ListTimeSeriesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTimeSeriesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTimeSeriesListCall) Fields ¶
func (c *ProjectsTimeSeriesListCall) Fields(s ...googleapi.Field) *ProjectsTimeSeriesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTimeSeriesListCall) Filter ¶
func (c *ProjectsTimeSeriesListCall) Filter(filter string) *ProjectsTimeSeriesListCall
Filter sets the optional parameter "filter": 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"
func (*ProjectsTimeSeriesListCall) IfNoneMatch ¶
func (c *ProjectsTimeSeriesListCall) IfNoneMatch(entityTag string) *ProjectsTimeSeriesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsTimeSeriesListCall) IntervalEndTime ¶
func (c *ProjectsTimeSeriesListCall) IntervalEndTime(intervalEndTime string) *ProjectsTimeSeriesListCall
IntervalEndTime sets the optional parameter "interval.endTime": Required. The end of the interval. The interval includes this time.
func (*ProjectsTimeSeriesListCall) IntervalStartTime ¶
func (c *ProjectsTimeSeriesListCall) IntervalStartTime(intervalStartTime string) *ProjectsTimeSeriesListCall
IntervalStartTime sets the optional parameter "interval.startTime": If this value is omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.
func (*ProjectsTimeSeriesListCall) OrderBy ¶
func (c *ProjectsTimeSeriesListCall) OrderBy(orderBy string) *ProjectsTimeSeriesListCall
OrderBy sets the optional parameter "orderBy": 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.
func (*ProjectsTimeSeriesListCall) PageSize ¶
func (c *ProjectsTimeSeriesListCall) PageSize(pageSize int64) *ProjectsTimeSeriesListCall
PageSize sets the optional parameter "pageSize": 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.
func (*ProjectsTimeSeriesListCall) PageToken ¶
func (c *ProjectsTimeSeriesListCall) PageToken(pageToken string) *ProjectsTimeSeriesListCall
PageToken sets the optional parameter "pageToken": 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.
func (*ProjectsTimeSeriesListCall) Pages ¶
func (c *ProjectsTimeSeriesListCall) Pages(ctx context.Context, f func(*ListTimeSeriesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ProjectsTimeSeriesListCall) View ¶
func (c *ProjectsTimeSeriesListCall) View(view string) *ProjectsTimeSeriesListCall
View sets the optional parameter "view": Specifies which information is returned about the time series.
Possible values:
"FULL" "HEADERS"
type ProjectsTimeSeriesService ¶
type ProjectsTimeSeriesService struct {
// contains filtered or unexported fields
}
func NewProjectsTimeSeriesService ¶
func NewProjectsTimeSeriesService(s *Service) *ProjectsTimeSeriesService
func (*ProjectsTimeSeriesService) Create ¶
func (r *ProjectsTimeSeriesService) Create(name string, createtimeseriesrequest *CreateTimeSeriesRequest) *ProjectsTimeSeriesCreateCall
Create: 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.
func (*ProjectsTimeSeriesService) List ¶
func (r *ProjectsTimeSeriesService) List(name string) *ProjectsTimeSeriesListCall
List: Lists time series that match a filter. This method does not require a Stackdriver account.
type Range ¶
type Range struct { // Max: The maximum of the population values. Max float64 `json:"max,omitempty"` // Min: The minimum of the population values. Min float64 `json:"min,omitempty"` // ForceSendFields is a list of field names (e.g. "Max") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Range: The range of the population values.
func (*Range) MarshalJSON ¶
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
type SourceContext ¶
type SourceContext struct { // FileName: The path-qualified name of the .proto file that contained // the associated protobuf element. For example: // "google/protobuf/source.proto". FileName string `json:"fileName,omitempty"` // ForceSendFields is a list of field names (e.g. "FileName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceContext: `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.
func (*SourceContext) MarshalJSON ¶
func (s *SourceContext) MarshalJSON() ([]byte, error)
type TimeInterval ¶
type TimeInterval struct { // EndTime: Required. The end of the interval. The interval includes // this time. EndTime string `json:"endTime,omitempty"` // StartTime: If this value is omitted, the interval is a point in time, // `endTime`. If `startTime` is present, it must be earlier than (less // than) `endTime`. The interval begins after `startTime`—it does not // include `startTime`. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
TimeInterval: A time interval extending from after `startTime` through `endTime`. If `startTime` is omitted, the interval is the single point in time, `endTime`.
func (*TimeInterval) MarshalJSON ¶
func (s *TimeInterval) MarshalJSON() ([]byte, error)
type TimeSeries ¶
type TimeSeries struct { // Metric: The fully-specified metric used to identify the time series. Metric *Metric `json:"metric,omitempty"` // MetricKind: The metric kind of the time series. This can be different // than the metric kind specified in [google.api.MetricDescriptor] // because of alignment and reduction operations on the data. This field // is ignored when writing data; the value specified in the descriptor // is used instead. @OutputOnly // // Possible values: // "METRIC_KIND_UNSPECIFIED" // "GAUGE" // "DELTA" // "CUMULATIVE" MetricKind string `json:"metricKind,omitempty"` // Points: The data points of this time series. When used as output, // points will be sorted by decreasing time order. When used as input, // points could be written in any orders. Points []*Point `json:"points,omitempty"` // Resource: The fully-specified monitored resource used to identify the // time series. Resource *MonitoredResource `json:"resource,omitempty"` // ValueType: The value type of the time series. This can be different // than the value type specified in [google.api.MetricDescriptor] // because of alignment and reduction operations on the data. This field // is ignored when writing data; the value specified in the descriptor // is used instead. @OutputOnly // // Possible values: // "VALUE_TYPE_UNSPECIFIED" // "BOOL" // "INT64" // "DOUBLE" // "STRING" // "DISTRIBUTION" // "MONEY" ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "Metric") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
TimeSeries: A collection of data points that describes the time-varying nature of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric.
func (*TimeSeries) MarshalJSON ¶
func (s *TimeSeries) MarshalJSON() ([]byte, error)
type Type ¶
type Type struct { // Fields: The list of fields. Fields []*Field `json:"fields,omitempty"` // Name: The fully qualified message name. Name string `json:"name,omitempty"` // Oneofs: The list of types appearing in `oneof` definitions in this // type. Oneofs []string `json:"oneofs,omitempty"` // Options: The protocol buffer options. Options []*Option `json:"options,omitempty"` // SourceContext: The source context. SourceContext *SourceContext `json:"sourceContext,omitempty"` // Syntax: The source syntax. // // Possible values: // "SYNTAX_PROTO2" // "SYNTAX_PROTO3" Syntax string `json:"syntax,omitempty"` // ForceSendFields is a list of field names (e.g. "Fields") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Type: A protocol buffer message type.
func (*Type) MarshalJSON ¶
type TypedValue ¶
type TypedValue struct { // BoolValue: A Boolean value: `true` or `false`. BoolValue bool `json:"boolValue,omitempty"` // DistributionValue: A distribution value. DistributionValue *Distribution `json:"distributionValue,omitempty"` // DoubleValue: A 64-bit double-precision floating-point number. Its // magnitude is approximately ±10±300 and it has 16 significant digits // of precision. DoubleValue float64 `json:"doubleValue,omitempty"` // Int64Value: A 64-bit integer. Its range is approximately ±9.2x1018. Int64Value int64 `json:"int64Value,omitempty,string"` // StringValue: A variable-length string value. StringValue string `json:"stringValue,omitempty"` // ForceSendFields is a list of field names (e.g. "BoolValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
TypedValue: A single strongly-typed value.
func (*TypedValue) MarshalJSON ¶
func (s *TypedValue) MarshalJSON() ([]byte, error)