Update docs (#291)
diff --git a/docs/dyn/logging_v2beta1.projects.metrics.html b/docs/dyn/logging_v2beta1.projects.metrics.html
index 02c17b6..6b4ae6c 100644
--- a/docs/dyn/logging_v2beta1.projects.metrics.html
+++ b/docs/dyn/logging_v2beta1.projects.metrics.html
@@ -72,109 +72,190 @@
</style>
-<h1><a href="logging_v2beta1.html">Google Cloud Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.metrics.html">metrics</a></h1>
+<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.metrics.html">metrics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(projectName, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a logs-based metric.</p>
<p class="toc_element">
- <code><a href="#delete">delete(metricName, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(metricName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a logs-based metric.</p>
<p class="toc_element">
- <code><a href="#get">get(metricName, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(metricName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a logs-based metric.</p>
<p class="toc_element">
- <code><a href="#list">list(projectName, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists logs-based metrics.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#update">update(metricName, body, x__xgafv=None)</a></code></p>
+ <code><a href="#update">update(metricName=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or updates a logs-based metric.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(projectName, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
<pre>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)
+ parent: 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.
+{ # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # 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. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # 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. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(metricName, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(metricName=None, x__xgafv=None)</code>
<pre>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)
+ 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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 `{}`.
+ { # 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 `{}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(metricName, x__xgafv=None)</code>
+ <code class="details" id="get">get(metricName=None, x__xgafv=None)</code>
<pre>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)
+ 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # 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. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(projectName, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>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. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.
- pageToken: string, Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response. The value of `projectName` must be the same as in the previous request.
+ parent: string, Required. The resource name containing the metrics.
+Example: `"projects/my-project-id"`. (required)
+ pageToken: string, 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.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, 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.
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.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # 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. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
},
],
- "nextPageToken": "A String", # If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call this
+ # method again using the value of `nextPageToken` as `pageToken`.
}</pre>
</div>
@@ -193,29 +274,61 @@
</div>
<div class="method">
- <code class="details" id="update">update(metricName, body, x__xgafv=None)</code>
+ <code class="details" id="update">update(metricName=None, body, x__xgafv=None)</code>
<pre>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)
+ 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.
+{ # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # 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. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # 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. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>