Documentation

Google_Service_Logging_Resource_ProjectsMetrics extends Google_Service_Resource
in package

The "metrics" collection of methods.

Typical usage is: $loggingService = new Google_Service_Logging(...); $metrics = $loggingService->metrics;

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_Logging_LogMetric
Creates a logs-based metric. (metrics.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Logging_LoggingEmpty
Deletes a logs-based metric. (metrics.delete)
get()  : Google_Service_Logging_LogMetric
Gets a logs-based metric. (metrics.get)
listProjectsMetrics()  : Google_Service_Logging_ListLogMetricsResponse
Lists logs-based metrics. (metrics.listProjectsMetrics)
update()  : Google_Service_Logging_LogMetric
Creates or updates a logs-based metric. (metrics.update)
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 a logs-based metric. (metrics.create)

public create(string $parent, Google_Service_Logging_LogMetric $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogMetric
Parameters
$parent : string

Required. The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request.

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

Optional parameters.

Return values
Google_Service_Logging_LogMetric

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

delete()

Deletes a logs-based metric. (metrics.delete)

public delete(string $metricName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LoggingEmpty
Parameters
$metricName : string

Required. The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

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

Optional parameters.

Return values
Google_Service_Logging_LoggingEmpty

get()

Gets a logs-based metric. (metrics.get)

public get(string $metricName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogMetric
Parameters
$metricName : string

Required. The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

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

Optional parameters.

Return values
Google_Service_Logging_LogMetric

listProjectsMetrics()

Lists logs-based metrics. (metrics.listProjectsMetrics)

public listProjectsMetrics(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_ListLogMetricsResponse
Parameters
$parent : string

Required. The name of the project containing the metrics: "projects/[PROJECT_ID]"

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

Optional parameters.

Tags
opt_param

string pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

opt_param

int pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

Return values
Google_Service_Logging_ListLogMetricsResponse

update()

Creates or updates a logs-based metric. (metrics.update)

public update(string $metricName, Google_Service_Logging_LogMetric $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogMetric
Parameters
$metricName : string

Required. The resource name of the metric to update: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.

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

Optional parameters.

Return values
Google_Service_Logging_LogMetric

convertToArrayAndStripNulls()

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

Search results