Class v3.MetricServiceClient (5.2.0)

Stay organized with collections Save and categorize content based on your preferences.

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  project (https://cloud.google.com/monitoring/api/v3#project_name) on which
   *  to execute the request. The format is:
   *  4
   *      projects/[PROJECT_ID_OR_NUMBER]
   */
  // const name = 'abc123'
  /**
   *  Required. The new custom
   *  metric (https://cloud.google.com/monitoring/custom-metrics) descriptor.
   */
  // const metricDescriptor = {}

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callCreateMetricDescriptor() {
    // Construct request
    const request = {
      name,
      metricDescriptor,
    };

    // Run request
    const response = await monitoringClient.createMetricDescriptor(request);
    console.log(response);
  }

  callCreateMetricDescriptor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  project (https://cloud.google.com/monitoring/api/v3#project_name) on which
   *  to execute the request. The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]
   */
  // const name = 'abc123'
  /**
   *  Required. The new data to be added to a list of time series.
   *  Adds at most one data point to each of several time series.  The new data
   *  point must be more recent than any other point in its time series.  Each
   *  `TimeSeries` value must fully specify a unique time series by supplying
   *  all label values for the metric and the monitored resource.
   *  The maximum number of `TimeSeries` objects per `Create` request is 200.
   */
  // const timeSeries = [1,2,3,4]

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callCreateServiceTimeSeries() {
    // Construct request
    const request = {
      name,
      timeSeries,
    };

    // Run request
    const response = await monitoringClient.createServiceTimeSeries(request);
    console.log(response);
  }

  callCreateServiceTimeSeries();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  project (https://cloud.google.com/monitoring/api/v3#project_name) on which
   *  to execute the request. The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]
   */
  // const name = 'abc123'
  /**
   *  Required. The new data to be added to a list of time series.
   *  Adds at most one data point to each of several time series.  The new data
   *  point must be more recent than any other point in its time series.  Each
   *  `TimeSeries` value must fully specify a unique time series by supplying
   *  all label values for the metric and the monitored resource.
   *  The maximum number of `TimeSeries` objects per `Create` request is 200.
   */
  // const timeSeries = [1,2,3,4]

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callCreateTimeSeries() {
    // Construct request
    const request = {
      name,
      timeSeries,
    };

    // Run request
    const response = await monitoringClient.createTimeSeries(request);
    console.log(response);
  }

  callCreateTimeSeries();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The metric descriptor on which to execute the request. The format
   *  is:
   *      projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
   *  An example of `[METRIC_ID]` is:
   *  `"custom.googleapis.com/my_test_metric"`.
   */
  // const name = 'abc123'

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callDeleteMetricDescriptor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await monitoringClient.deleteMetricDescriptor(request);
    console.log(response);
  }

  callDeleteMetricDescriptor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The metric descriptor on which to execute the request. The format
   *  is:
   *      projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
   *  An example value of `[METRIC_ID]` is
   *  `"compute.googleapis.com/instance/disk/read_bytes_count"`.
   */
  // const name = 'abc123'

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callGetMetricDescriptor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await monitoringClient.getMetricDescriptor(request);
    console.log(response);
  }

  callGetMetricDescriptor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The monitored resource descriptor to get.  The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]
   *  The `[RESOURCE_TYPE]` is a predefined type, such as
   *  `cloudsql_database`.
   */
  // const name = 'abc123'

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callGetMonitoredResourceDescriptor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await monitoringClient.getMonitoredResourceDescriptor(request);
    console.log(response);
  }

  callGetMonitoredResourceDescriptor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  project (https://cloud.google.com/monitoring/api/v3#project_name) on which
   *  to execute the request. The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]
   */
  // const name = 'abc123'
  /**
   *  Optional. If this field is empty, all custom and
   *  system-defined metric descriptors are returned.
   *  Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters)
   *  specifies which metric descriptors are to be
   *  returned. For example, the following filter matches all
   *  custom metrics (https://cloud.google.com/monitoring/custom-metrics):
   *      metric.type = starts_with("custom.googleapis.com/")
   */
  // const filter = 'abc123'
  /**
   *  Optional. A positive number that is the maximum number of results to
   *  return. The default and maximum value is 10,000. If a page_size <= 0="" or="">
   *  10,000 is submitted, will instead return a maximum of 10,000 results.
   */
  // const pageSize = 1234
  /**
   *  Optional. 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.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. If true, only metrics and monitored resource types that have
   *  recent data (within roughly 25 hours) will be included in the response.
   *   - If a metric descriptor enumerates monitored resource types, only the
   *     monitored resource types for which the metric type has recent data will
   *     be included in the returned metric descriptor, and if none of them have
   *     recent data, the metric descriptor will not be returned.
   *   - If a metric descriptor does not enumerate the compatible monitored
   *     resource types, it will be returned only if the metric type has recent
   *     data for some monitored resource type. The returned descriptor will not
   *     enumerate any monitored resource types.
   */
  // const activeOnly = true

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callListMetricDescriptors() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const iterable = monitoringClient.listMetricDescriptorsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListMetricDescriptors();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  project (https://cloud.google.com/monitoring/api/v3#project_name) on which
   *  to execute the request. The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]
   */
  // const name = 'abc123'
  /**
   *  An optional filter (https://cloud.google.com/monitoring/api/v3/filters)
   *  describing the descriptors to be returned.  The filter can reference the
   *  descriptor's type and labels. For example, the following filter returns
   *  only Google Compute Engine descriptors that have an `id` label:
   *      resource.type = starts_with("gce_") AND resource.label:id
   */
  // const filter = 'abc123'
  /**
   *  A positive number that is the maximum number of results to return.
   */
  // const pageSize = 1234
  /**
   *  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.
   */
  // const pageToken = 'abc123'

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callListMonitoredResourceDescriptors() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const iterable = monitoringClient.listMonitoredResourceDescriptorsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListMonitoredResourceDescriptors();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  project (https://cloud.google.com/monitoring/api/v3#project_name),
   *  organization or folder on which to execute the request. The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]
   *      organizations/[ORGANIZATION_ID]
   *      folders/[FOLDER_ID]
   */
  // const name = 'abc123'
  /**
   *  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"
   */
  // const filter = 'abc123'
  /**
   *  Required. The time interval for which results should be returned. Only time
   *  series that contain data points in the specified interval are included in
   *  the response.
   */
  // const interval = {}
  /**
   *  Specifies the alignment of data points in individual time series as
   *  well as how to combine the retrieved time series across specified labels.
   *  By default (if no `aggregation` is explicitly specified), the raw time
   *  series data is returned.
   */
  // const aggregation = {}
  /**
   *  Apply a second aggregation after `aggregation` is applied. May only be
   *  specified if `aggregation` is specified.
   */
  // const secondaryAggregation = {}
  /**
   *  Unsupported: must be left blank. The points in each time series are
   *  currently returned in reverse time order (most recent to oldest).
   */
  // const orderBy = 'abc123'
  /**
   *  Required. Specifies which information is returned about the time series.
   */
  // const view = {}
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  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.
   */
  // const pageToken = 'abc123'

  // Imports the Monitoring library
  const {MetricServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new MetricServiceClient();

  async function callListTimeSeries() {
    // Construct request
    const request = {
      name,
      filter,
      interval,
      view,
    };

    // Run request
    const iterable = monitoringClient.listTimeSeriesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTimeSeries();