# Google Cloud Logging API . projects . metrics

## Instance Methods

Creates a logs-based metric.

Deletes a logs-based metric.

Gets a logs-based metric.

Lists logs-based metrics.

Retrieves the next page of results.

Creates or updates a logs-based metric.

### Method Details

`create(projectName, body, x__xgafv=None)`

    Creates a logs-based metric.

    Args:
      projectName: string, The resource name of the project in which to create the metric. Example: `"projects/my-project-id"`. The new metric must be provided in the request. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
        "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
        "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
        "description": "A String", # A description of this metric, which is used in documentation.
      }

      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
          "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
          "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
          "description": "A String", # A description of this metric, which is used in documentation.
        }

`delete(metricName, x__xgafv=None)`

    Deletes a logs-based metric.

    Args:
      metricName: string, The resource name of the metric to delete. Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
      }

`get(metricName, x__xgafv=None)`

    Gets a logs-based metric.

    Args:
      metricName: string, The resource name of the desired metric. Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
          "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
          "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
          "description": "A String", # A description of this metric, which is used in documentation.
        }

`list(projectName, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists logs-based metrics.

    Args:
      projectName: string, Required. The resource name of the project containing the metrics. Example: `"projects/my-project-id"`. (required)
      pageSize: integer, Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.
      pageToken: string, Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request. The value of `projectName` must be the same as in the previous request.
      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # Result returned from ListLogMetrics.
        "metrics": [ # A list of logs-based metrics.
          { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
              "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
              "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
              "description": "A String", # A description of this metric, which is used in documentation.
            },
        ],
        "nextPageToken": "A String", # If there are more results than were returned, then `nextPageToken` is given a value in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`.
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.

`update(metricName, body, x__xgafv=None)`

    Creates or updates a logs-based metric.

    Args:
      metricName: string, The resource name of the metric to update. Example: `"projects/my-project-id/metrics/my-metric-id"`. The updated metric must be provided in the request and have the same identifier that is specified in `metricName`. If the metric does not exist, it is created. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
        "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
        "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
        "description": "A String", # A description of this metric, which is used in documentation.
      }

      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
          "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
          "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
          "description": "A String", # A description of this metric, which is used in documentation.
        }