Documentation

Google_Service_Monitoring_Resource_ProjectsTimeSeries extends Google_Service_Resource
in package

The "timeSeries" collection of methods.

Typical usage is: $monitoringService = new Google_Service_Monitoring(...); $timeSeries = $monitoringService->timeSeries;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Monitoring_MonitoringEmpty
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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listProjectsTimeSeries()  : Google_Service_Monitoring_ListTimeSeriesResponse
Lists time series that match a filter. This method does not require a Workspace. (timeSeries.listProjectsTimeSeries)
query()  : Google_Service_Monitoring_QueryTimeSeriesResponse
Queries time series using Monitoring Query Language. This method does not require a Workspace. (timeSeries.query)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

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.

public create(string $name, Google_Service_Monitoring_CreateTimeSeriesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_MonitoringEmpty

(timeSeries.create)

Parameters
$name : string

Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

$postBody : Google_Service_Monitoring_CreateTimeSeriesRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Monitoring_MonitoringEmpty —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

listProjectsTimeSeries()

Lists time series that match a filter. This method does not require a Workspace. (timeSeries.listProjectsTimeSeries)

public listProjectsTimeSeries(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_ListTimeSeriesResponse
Parameters
$name : string

Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter Required. A monitoring filter (https://cloud.google.com/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.labels.instance_name = "my-instance-name"

opt_param

string aggregation.crossSeriesReducer The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.

opt_param

string aggregation.perSeriesAligner An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.

opt_param

string orderBy Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

opt_param

string aggregation.alignmentPeriod The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per- series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.

opt_param

string interval.endTime Required. The end of the time interval.

opt_param

string aggregation.groupByFields The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. 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 cross_series_reducer 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 group_by_fields are aggregated away. If group_by_fields 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 cross_series_reducer is not defined, this field is ignored.

opt_param

string view Required. Specifies which information is returned about the time series.

opt_param

string interval.startTime 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.

opt_param

int pageSize 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.

opt_param

string 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.

Return values
Google_Service_Monitoring_ListTimeSeriesResponse —

query()

Queries time series using Monitoring Query Language. This method does not require a Workspace. (timeSeries.query)

public query(string $name, Google_Service_Monitoring_QueryTimeSeriesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_QueryTimeSeriesResponse
Parameters
$name : string

Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

$postBody : Google_Service_Monitoring_QueryTimeSeriesRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Monitoring_QueryTimeSeriesResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results