Method | Description | |
---|---|---|
__construct ( array $options = [] ) | Constructor. | |
close ( ) | Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled. | |
createLogMetric ( string $parent, google\logging\v2\LogMetric $metric, array $optionalArgs = [] ) : google\logging\v2\LogMetric | Creates a logs-based metric. | |
deleteLogMetric ( string $metricName, array $optionalArgs = [] ) | Deletes a logs-based metric. | |
formatMetricName ( $project, $metric ) | Formats a string containing the fully-qualified path to represent a metric resource. | |
formatProjectName ( $project ) | Formats a string containing the fully-qualified path to represent a project resource. | |
getLogMetric ( string $metricName, array $optionalArgs = [] ) : google\logging\v2\LogMetric | Gets a logs-based metric. | |
listLogMetrics ( string $parent, array $optionalArgs = [] ) : Google\GAX\PagedListResponse | Lists logs-based metrics. | |
parseMetricFromMetricName ( $metricName ) | Parses the metric from the given fully-qualified path which represents a metric resource. | |
parseProjectFromMetricName ( $metricName ) | Parses the project from the given fully-qualified path which represents a metric resource. | |
parseProjectFromProjectName ( $projectName ) | Parses the project from the given fully-qualified path which represents a project resource. | |
updateLogMetric ( string $metricName, google\logging\v2\LogMetric $metric, array $optionalArgs = [] ) : google\logging\v2\LogMetric | Creates or updates a logs-based metric. |
Method | Description | |
---|---|---|
createCredentialsCallback ( ) | ||
getMetricNameTemplate ( ) | ||
getPageStreamingDescriptors ( ) | ||
getProjectNameTemplate ( ) |
public __construct ( array $options = [] ) | ||
$options | array | { Optional. Options for configuring the service API wrapper. @type string $serviceAddress The domain name of the API remote host. Default 'logging.googleapis.com'. @type mixed $port The port on which to connect to the remote host. Default 443. @type Grpc\ChannelCredentials $sslCreds A `ChannelCredentials` for use with an SSL-enabled channel. Default: a credentials object returned from Grpc\ChannelCredentials::createSsl() @type array $scopes A string array of scopes to use when acquiring credentials. Default the scopes for the Stackdriver Logging API. @type array $retryingOverride An associative array of string => RetryOptions, where the keys are method names (e.g. 'createFoo'), that overrides default retrying settings. A value of null indicates that the method in question should not retry. @type int $timeoutMillis The timeout in milliseconds to use for calls that don't use retries. For calls that use retries, set the timeout in RetryOptions. Default: 30000 (30 seconds) @type string $appName The codename of the calling service. Default 'gax'. @type string $appVersion The version of the calling service. Default: the current version of GAX. @type Google\Auth\CredentialsLoader $credentialsLoader A CredentialsLoader object created using the Google\Auth library. } |
public close ( ) |
public createLogMetric ( string $parent, google\logging\v2\LogMetric $metric, array $optionalArgs = [] ) : google\logging\v2\LogMetric | ||
$parent | string | The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request. |
$metric | google\logging\v2\LogMetric | The new logs-based metric, which must not have an identifier that already exists. |
$optionalArgs | array | { Optional. @type \Google\GAX\RetrySettings $retrySettings Retry settings to use for this call. If present, then $timeoutMillis is ignored. @type int $timeoutMillis Timeout to use for this call. Only used if $retrySettings is not set. } |
return | google\logging\v2\LogMetric |
public deleteLogMetric ( string $metricName, array $optionalArgs = [] ) | ||
$metricName | string | The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" |
$optionalArgs | array | { Optional. @type \Google\GAX\RetrySettings $retrySettings Retry settings to use for this call. If present, then $timeoutMillis is ignored. @type int $timeoutMillis Timeout to use for this call. Only used if $retrySettings is not set. } |
public static formatMetricName ( $project, $metric ) |
public static formatProjectName ( $project ) |
public getLogMetric ( string $metricName, array $optionalArgs = [] ) : google\logging\v2\LogMetric | ||
$metricName | string | The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" |
$optionalArgs | array | { Optional. @type \Google\GAX\RetrySettings $retrySettings Retry settings to use for this call. If present, then $timeoutMillis is ignored. @type int $timeoutMillis Timeout to use for this call. Only used if $retrySettings is not set. } |
return | google\logging\v2\LogMetric |
public listLogMetrics ( string $parent, array $optionalArgs = [] ) : Google\GAX\PagedListResponse | ||
$parent | string | Required. The name of the project containing the metrics: "projects/[PROJECT_ID]" |
$optionalArgs | array | { Optional. @type string $pageToken A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. @type int $pageSize The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. @type \Google\GAX\RetrySettings $retrySettings Retry settings to use for this call. If present, then $timeoutMillis is ignored. @type int $timeoutMillis Timeout to use for this call. Only used if $retrySettings is not set. } |
return | Google\GAX\PagedListResponse |
public static parseMetricFromMetricName ( $metricName ) |
public static parseProjectFromMetricName ( $metricName ) |
public static parseProjectFromProjectName ( $projectName ) |
public updateLogMetric ( string $metricName, google\logging\v2\LogMetric $metric, array $optionalArgs = [] ) : google\logging\v2\LogMetric | ||
$metricName | string | 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. |
$metric | google\logging\v2\LogMetric | The updated metric. |
$optionalArgs | array | { Optional. @type \Google\GAX\RetrySettings $retrySettings Retry settings to use for this call. If present, then $timeoutMillis is ignored. @type int $timeoutMillis Timeout to use for this call. Only used if $retrySettings is not set. } |
return | google\logging\v2\LogMetric |