google_api_monitoring v0.7.0 GoogleApi.Monitoring.V3.Api.MetricDescriptors View Source

API calls for all endpoints tagged MetricDescriptors.

Link to this section Summary

Functions

Creates a new metric descriptor. User-created metric descriptors define custom metrics.

Gets a single metric descriptor. This method does not require a Stackdriver account.

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Link to this section Functions

Link to this function

monitoring_metric_descriptors_create(connection, v3_id, v3_id1, optional_params \\ [], opts \\ []) View Source

Creates a new metric descriptor. User-created metric descriptors define custom metrics.

Parameters

  • connection (GoogleApi.Monitoring.V3.Connection): Connection to server
  • v3_id (String.t): Part of `name`. The project on which to execute the request. The format is "projects/{project_id_or_number}".
  • v3_id1 (String.t): Part of `name`. See documentation of `v3Id`.
  • optional_params (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (MetricDescriptor):

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.MetricDescriptor{}} on success {:error, info} on failure

Link to this function

monitoring_metric_descriptors_delete(connection, v3_id, v3_id1, metric_descriptors_id, optional_params \\ [], opts \\ []) View Source

Deletes a metric descriptor. Only user-created custom metrics can be deleted.

Parameters

  • connection (GoogleApi.Monitoring.V3.Connection): Connection to server
  • v3_id (String.t): Part of `name`. 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".
  • v3_id1 (String.t): Part of `name`. See documentation of `v3Id`.
  • metric_descriptors_id (String.t): Part of `name`. See documentation of `v3Id`.
  • optional_params (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.Empty{}} on success {:error, info} on failure

Link to this function

monitoring_metric_descriptors_get(connection, v3_id, v3_id1, metric_descriptors_id, optional_params \\ [], opts \\ []) View Source

Gets a single metric descriptor. This method does not require a Stackdriver account.

Parameters

  • connection (GoogleApi.Monitoring.V3.Connection): Connection to server
  • v3_id (String.t): Part of `name`. 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".
  • v3_id1 (String.t): Part of `name`. See documentation of `v3Id`.
  • metric_descriptors_id (String.t): Part of `name`. See documentation of `v3Id`.
  • optional_params (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.MetricDescriptor{}} on success {:error, info} on failure

Link to this function

monitoring_metric_descriptors_list(connection, v3_id, v3_id1, optional_params \\ [], opts \\ []) View Source

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Parameters

  • connection (GoogleApi.Monitoring.V3.Connection): Connection to server
  • v3_id (String.t): Part of `name`. The project on which to execute the request. The format is "projects/{project_id_or_number}".
  • v3_id1 (String.t): Part of `name`. See documentation of `v3Id`.
  • optional_params (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :pageToken (String.t): 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.
    • :pageSize (integer()): A positive number that is the maximum number of results to return.
    • :filter (String.t): If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/")

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.ListMetricDescriptorsResponse{}} on success {:error, info} on failure