MetricsServiceV2Client

v2. MetricsServiceV2Client

Service for configuring logs-based metrics.

Constructor

new MetricsServiceV2Client(optionsopt, fallback)

Construct an instance of MetricsServiceV2Client.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

client configuration override. TODO(@alexander-fenster): link to gax documentation.

fallback boolean

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

billingAccountCmekSettingsPath(billing_account) → {string}

Return a fully-qualified billingAccountCmekSettings resource name string.

Parameters:
Name Type Description
billing_account string
Returns:
Type Description
string

Resource name string.

billingAccountExclusionPath(billing_account, exclusion) → {string}

Return a fully-qualified billingAccountExclusion resource name string.

Parameters:
Name Type Description
billing_account string
exclusion string
Returns:
Type Description
string

Resource name string.

billingAccountLocationBucketPath(billing_account, location, bucket) → {string}

Return a fully-qualified billingAccountLocationBucket resource name string.

Parameters:
Name Type Description
billing_account string
location string
bucket string
Returns:
Type Description
string

Resource name string.

billingAccountLogPath(billing_account, log) → {string}

Return a fully-qualified billingAccountLog resource name string.

Parameters:
Name Type Description
billing_account string
log string
Returns:
Type Description
string

Resource name string.

billingAccountSinkPath(billing_account, sink) → {string}

Return a fully-qualified billingAccountSink resource name string.

Parameters:
Name Type Description
billing_account string
sink string
Returns:
Type Description
string

Resource name string.

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

createLogMetric(request, optionsopt) → {Promise}

Creates a logs-based metric.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
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.

metric google.logging.v2.LogMetric

Required. The new logs-based metric, which must not have an identifier that already exists.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing LogMetric. Please see the documentation for more details and examples.
Example
const [response] = await client.createLogMetric(request);

deleteLogMetric(request, optionsopt) → {Promise}

Deletes a logs-based metric.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
metricName string

Required. The resource name of the metric to delete:

  "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteLogMetric(request);

folderCmekSettingsPath(folder) → {string}

Return a fully-qualified folderCmekSettings resource name string.

Parameters:
Name Type Description
folder string
Returns:
Type Description
string

Resource name string.

folderExclusionPath(folder, exclusion) → {string}

Return a fully-qualified folderExclusion resource name string.

Parameters:
Name Type Description
folder string
exclusion string
Returns:
Type Description
string

Resource name string.

folderLocationBucketPath(folder, location, bucket) → {string}

Return a fully-qualified folderLocationBucket resource name string.

Parameters:
Name Type Description
folder string
location string
bucket string
Returns:
Type Description
string

Resource name string.

folderLogPath(folder, log) → {string}

Return a fully-qualified folderLog resource name string.

Parameters:
Name Type Description
folder string
log string
Returns:
Type Description
string

Resource name string.

folderSinkPath(folder, sink) → {string}

Return a fully-qualified folderSink resource name string.

Parameters:
Name Type Description
folder string
sink string
Returns:
Type Description
string

Resource name string.

getLogMetric(request, optionsopt) → {Promise}

Gets a logs-based metric.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
metricName string

Required. The resource name of the desired metric:

  "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing LogMetric. Please see the documentation for more details and examples.
Example
const [response] = await client.getLogMetric(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listLogMetrics(request, optionsopt) → {Promise}

Lists logs-based metrics.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"
pageToken string <optional>

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.

pageSize number <optional>

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.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of LogMetric. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listLogMetricsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLogMetricsAsync(request, optionsopt) → {Object}

Equivalent to listLogMetrics, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"
pageToken string <optional>

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.

pageSize number <optional>

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.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing LogMetric. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example
const iterable = client.listLogMetricsAsync(request);
for await (const response of iterable) {
  // process response
}

listLogMetricsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"
pageToken string <optional>

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.

pageSize number <optional>

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.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing LogMetric on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listLogMetricsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

logMetricPath(project, metric) → {string}

Return a fully-qualified logMetric resource name string.

Parameters:
Name Type Description
project string
metric string
Returns:
Type Description
string

Resource name string.

matchBillingAccountFromBillingAccountCmekSettingsName(billingAccountCmekSettingsName) → {string}

Parse the billing_account from BillingAccountCmekSettings resource.

Parameters:
Name Type Description
billingAccountCmekSettingsName string

A fully-qualified path representing billing_account_cmekSettings resource.

Returns:
Type Description
string

A string representing the billing_account.

matchBillingAccountFromBillingAccountExclusionName(billingAccountExclusionName) → {string}

Parse the billing_account from BillingAccountExclusion resource.

Parameters:
Name Type Description
billingAccountExclusionName string

A fully-qualified path representing billing_account_exclusion resource.

Returns:
Type Description
string

A string representing the billing_account.

matchBillingAccountFromBillingAccountLocationBucketName(billingAccountLocationBucketName) → {string}

Parse the billing_account from BillingAccountLocationBucket resource.

Parameters:
Name Type Description
billingAccountLocationBucketName string

A fully-qualified path representing billing_account_location_bucket resource.

Returns:
Type Description
string

A string representing the billing_account.

matchBillingAccountFromBillingAccountLogName(billingAccountLogName) → {string}

Parse the billing_account from BillingAccountLog resource.

Parameters:
Name Type Description
billingAccountLogName string

A fully-qualified path representing billing_account_log resource.

Returns:
Type Description
string

A string representing the billing_account.

matchBillingAccountFromBillingAccountSinkName(billingAccountSinkName) → {string}

Parse the billing_account from BillingAccountSink resource.

Parameters:
Name Type Description
billingAccountSinkName string

A fully-qualified path representing billing_account_sink resource.

Returns:
Type Description
string

A string representing the billing_account.

matchBucketFromBillingAccountLocationBucketName(billingAccountLocationBucketName) → {string}

Parse the bucket from BillingAccountLocationBucket resource.

Parameters:
Name Type Description
billingAccountLocationBucketName string

A fully-qualified path representing billing_account_location_bucket resource.

Returns:
Type Description
string

A string representing the bucket.

matchBucketFromFolderLocationBucketName(folderLocationBucketName) → {string}

Parse the bucket from FolderLocationBucket resource.

Parameters:
Name Type Description
folderLocationBucketName string

A fully-qualified path representing folder_location_bucket resource.

Returns:
Type Description
string

A string representing the bucket.

matchBucketFromOrganizationLocationBucketName(organizationLocationBucketName) → {string}

Parse the bucket from OrganizationLocationBucket resource.

Parameters:
Name Type Description
organizationLocationBucketName string

A fully-qualified path representing organization_location_bucket resource.

Returns:
Type Description
string

A string representing the bucket.

matchBucketFromProjectLocationBucketName(projectLocationBucketName) → {string}

Parse the bucket from ProjectLocationBucket resource.

Parameters:
Name Type Description
projectLocationBucketName string

A fully-qualified path representing project_location_bucket resource.

Returns:
Type Description
string

A string representing the bucket.

matchExclusionFromBillingAccountExclusionName(billingAccountExclusionName) → {string}

Parse the exclusion from BillingAccountExclusion resource.

Parameters:
Name Type Description
billingAccountExclusionName string

A fully-qualified path representing billing_account_exclusion resource.

Returns:
Type Description
string

A string representing the exclusion.

matchExclusionFromFolderExclusionName(folderExclusionName) → {string}

Parse the exclusion from FolderExclusion resource.

Parameters:
Name Type Description
folderExclusionName string

A fully-qualified path representing folder_exclusion resource.

Returns:
Type Description
string

A string representing the exclusion.

matchExclusionFromOrganizationExclusionName(organizationExclusionName) → {string}

Parse the exclusion from OrganizationExclusion resource.

Parameters:
Name Type Description
organizationExclusionName string

A fully-qualified path representing organization_exclusion resource.

Returns:
Type Description
string

A string representing the exclusion.

matchExclusionFromProjectExclusionName(projectExclusionName) → {string}

Parse the exclusion from ProjectExclusion resource.

Parameters:
Name Type Description
projectExclusionName string

A fully-qualified path representing project_exclusion resource.

Returns:
Type Description
string

A string representing the exclusion.

matchFolderFromFolderCmekSettingsName(folderCmekSettingsName) → {string}

Parse the folder from FolderCmekSettings resource.

Parameters:
Name Type Description
folderCmekSettingsName string

A fully-qualified path representing folder_cmekSettings resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderExclusionName(folderExclusionName) → {string}

Parse the folder from FolderExclusion resource.

Parameters:
Name Type Description
folderExclusionName string

A fully-qualified path representing folder_exclusion resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderLocationBucketName(folderLocationBucketName) → {string}

Parse the folder from FolderLocationBucket resource.

Parameters:
Name Type Description
folderLocationBucketName string

A fully-qualified path representing folder_location_bucket resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderLogName(folderLogName) → {string}

Parse the folder from FolderLog resource.

Parameters:
Name Type Description
folderLogName string

A fully-qualified path representing folder_log resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderSinkName(folderSinkName) → {string}

Parse the folder from FolderSink resource.

Parameters:
Name Type Description
folderSinkName string

A fully-qualified path representing folder_sink resource.

Returns:
Type Description
string

A string representing the folder.

matchLocationFromBillingAccountLocationBucketName(billingAccountLocationBucketName) → {string}

Parse the location from BillingAccountLocationBucket resource.

Parameters:
Name Type Description
billingAccountLocationBucketName string

A fully-qualified path representing billing_account_location_bucket resource.

Returns:
Type Description
string

A string representing the location.

matchLocationFromFolderLocationBucketName(folderLocationBucketName) → {string}

Parse the location from FolderLocationBucket resource.

Parameters:
Name Type Description
folderLocationBucketName string

A fully-qualified path representing folder_location_bucket resource.

Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationLocationBucketName(organizationLocationBucketName) → {string}

Parse the location from OrganizationLocationBucket resource.

Parameters:
Name Type Description
organizationLocationBucketName string

A fully-qualified path representing organization_location_bucket resource.

Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationBucketName(projectLocationBucketName) → {string}

Parse the location from ProjectLocationBucket resource.

Parameters:
Name Type Description
projectLocationBucketName string

A fully-qualified path representing project_location_bucket resource.

Returns:
Type Description
string

A string representing the location.

matchLogFromBillingAccountLogName(billingAccountLogName) → {string}

Parse the log from BillingAccountLog resource.

Parameters:
Name Type Description
billingAccountLogName string

A fully-qualified path representing billing_account_log resource.

Returns:
Type Description
string

A string representing the log.

matchLogFromFolderLogName(folderLogName) → {string}

Parse the log from FolderLog resource.

Parameters:
Name Type Description
folderLogName string

A fully-qualified path representing folder_log resource.

Returns:
Type Description
string

A string representing the log.

matchLogFromOrganizationLogName(organizationLogName) → {string}

Parse the log from OrganizationLog resource.

Parameters:
Name Type Description
organizationLogName string

A fully-qualified path representing organization_log resource.

Returns:
Type Description
string

A string representing the log.

matchLogFromProjectLogName(projectLogName) → {string}

Parse the log from ProjectLog resource.

Parameters:
Name Type Description
projectLogName string

A fully-qualified path representing project_log resource.

Returns:
Type Description
string

A string representing the log.

matchMetricFromLogMetricName(logMetricName) → {string}

Parse the metric from LogMetric resource.

Parameters:
Name Type Description
logMetricName string

A fully-qualified path representing LogMetric resource.

Returns:
Type Description
string

A string representing the metric.

matchOrganizationFromOrganizationCmekSettingsName(organizationCmekSettingsName) → {string}

Parse the organization from OrganizationCmekSettings resource.

Parameters:
Name Type Description
organizationCmekSettingsName string

A fully-qualified path representing organization_cmekSettings resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationExclusionName(organizationExclusionName) → {string}

Parse the organization from OrganizationExclusion resource.

Parameters:
Name Type Description
organizationExclusionName string

A fully-qualified path representing organization_exclusion resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLocationBucketName(organizationLocationBucketName) → {string}

Parse the organization from OrganizationLocationBucket resource.

Parameters:
Name Type Description
organizationLocationBucketName string

A fully-qualified path representing organization_location_bucket resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLogName(organizationLogName) → {string}

Parse the organization from OrganizationLog resource.

Parameters:
Name Type Description
organizationLogName string

A fully-qualified path representing organization_log resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationSinkName(organizationSinkName) → {string}

Parse the organization from OrganizationSink resource.

Parameters:
Name Type Description
organizationSinkName string

A fully-qualified path representing organization_sink resource.

Returns:
Type Description
string

A string representing the organization.

matchProjectFromLogMetricName(logMetricName) → {string}

Parse the project from LogMetric resource.

Parameters:
Name Type Description
logMetricName string

A fully-qualified path representing LogMetric resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectCmekSettingsName(projectCmekSettingsName) → {string}

Parse the project from ProjectCmekSettings resource.

Parameters:
Name Type Description
projectCmekSettingsName string

A fully-qualified path representing project_cmekSettings resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectExclusionName(projectExclusionName) → {string}

Parse the project from ProjectExclusion resource.

Parameters:
Name Type Description
projectExclusionName string

A fully-qualified path representing project_exclusion resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationBucketName(projectLocationBucketName) → {string}

Parse the project from ProjectLocationBucket resource.

Parameters:
Name Type Description
projectLocationBucketName string

A fully-qualified path representing project_location_bucket resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLogName(projectLogName) → {string}

Parse the project from ProjectLog resource.

Parameters:
Name Type Description
projectLogName string

A fully-qualified path representing project_log resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSinkName(projectSinkName) → {string}

Parse the project from ProjectSink resource.

Parameters:
Name Type Description
projectSinkName string

A fully-qualified path representing project_sink resource.

Returns:
Type Description
string

A string representing the project.

matchSinkFromBillingAccountSinkName(billingAccountSinkName) → {string}

Parse the sink from BillingAccountSink resource.

Parameters:
Name Type Description
billingAccountSinkName string

A fully-qualified path representing billing_account_sink resource.

Returns:
Type Description
string

A string representing the sink.

matchSinkFromFolderSinkName(folderSinkName) → {string}

Parse the sink from FolderSink resource.

Parameters:
Name Type Description
folderSinkName string

A fully-qualified path representing folder_sink resource.

Returns:
Type Description
string

A string representing the sink.

matchSinkFromOrganizationSinkName(organizationSinkName) → {string}

Parse the sink from OrganizationSink resource.

Parameters:
Name Type Description
organizationSinkName string

A fully-qualified path representing organization_sink resource.

Returns:
Type Description
string

A string representing the sink.

matchSinkFromProjectSinkName(projectSinkName) → {string}

Parse the sink from ProjectSink resource.

Parameters:
Name Type Description
projectSinkName string

A fully-qualified path representing project_sink resource.

Returns:
Type Description
string

A string representing the sink.

organizationCmekSettingsPath(organization) → {string}

Return a fully-qualified organizationCmekSettings resource name string.

Parameters:
Name Type Description
organization string
Returns:
Type Description
string

Resource name string.

organizationExclusionPath(organization, exclusion) → {string}

Return a fully-qualified organizationExclusion resource name string.

Parameters:
Name Type Description
organization string
exclusion string
Returns:
Type Description
string

Resource name string.

organizationLocationBucketPath(organization, location, bucket) → {string}

Return a fully-qualified organizationLocationBucket resource name string.

Parameters:
Name Type Description
organization string
location string
bucket string
Returns:
Type Description
string

Resource name string.

organizationLogPath(organization, log) → {string}

Return a fully-qualified organizationLog resource name string.

Parameters:
Name Type Description
organization string
log string
Returns:
Type Description
string

Resource name string.

organizationSinkPath(organization, sink) → {string}

Return a fully-qualified organizationSink resource name string.

Parameters:
Name Type Description
organization string
sink string
Returns:
Type Description
string

Resource name string.

projectCmekSettingsPath(project) → {string}

Return a fully-qualified projectCmekSettings resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

projectExclusionPath(project, exclusion) → {string}

Return a fully-qualified projectExclusion resource name string.

Parameters:
Name Type Description
project string
exclusion string
Returns:
Type Description
string

Resource name string.

projectLocationBucketPath(project, location, bucket) → {string}

Return a fully-qualified projectLocationBucket resource name string.

Parameters:
Name Type Description
project string
location string
bucket string
Returns:
Type Description
string

Resource name string.

projectLogPath(project, log) → {string}

Return a fully-qualified projectLog resource name string.

Parameters:
Name Type Description
project string
log string
Returns:
Type Description
string

Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

projectSinkPath(project, sink) → {string}

Return a fully-qualified projectSink resource name string.

Parameters:
Name Type Description
project string
sink string
Returns:
Type Description
string

Resource name string.

updateLogMetric(request, optionsopt) → {Promise}

Creates or updates a logs-based metric.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
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.

metric google.logging.v2.LogMetric

Required. The updated metric.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing LogMetric. Please see the documentation for more details and examples.
Example
const [response] = await client.updateLogMetric(request);