google_api_monitoring v0.2.0 GoogleApi.Monitoring.V3.Api.TimeSeries View Source
API calls for all endpoints tagged TimeSeries
.
Link to this section Summary
Functions
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
Lists time series that match a filter. This method does not require a Stackdriver account
Link to this section Functions
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.
Parameters
- connection (GoogleApi.Monitoring.V3.Connection): Connection to server
- v3_id (String.t): Part of `name`. The project on which to execute the request. The format is "projects/{project_id_or_number}".
- v3_id1 (String.t): Part of `name`. See documentation of `v3Id`.
optional_params (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (CreateTimeSeriesRequest):
Returns
{:ok, %GoogleApi.Monitoring.V3.Model.Empty{}} on success {:error, info} on failure
Lists time series that match a filter. This method does not require a Stackdriver account.
Parameters
- connection (GoogleApi.Monitoring.V3.Connection): Connection to server
- v3_id (String.t): Part of `name`. The project on which to execute the request. The format is "projects/{project_id_or_number}".
- v3_id1 (String.t): Part of `name`. See documentation of `v3Id`.
optional_params (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :aggregation.groupByFields ([String.t]): The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
- :interval.endTime (DateTime.t): Required. The end of the time interval.
- :aggregation.alignmentPeriod (String.t): The alignment period for per-time series 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.
- :pageSize (integer()): A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.
- :orderBy (String.t): Unsupported: must be left blank. The points in each time series are returned in reverse time order.
- :aggregation.crossSeriesReducer (String.t): 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.
- :filter (String.t): A monitoring filter 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"
- :pageToken (String.t): 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.
- :aggregation.perSeriesAligner (String.t): 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.
- :interval.startTime (DateTime.t): Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
- :view (String.t): Specifies which information is returned about the time series.
Returns
{:ok, %GoogleApi.Monitoring.V3.Model.ListTimeSeriesResponse{}} on success {:error, info} on failure