docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudtrace_v1.projects.traces.html b/docs/dyn/cloudtrace_v1.projects.traces.html
index 13df879..412af8b 100644
--- a/docs/dyn/cloudtrace_v1.projects.traces.html
+++ b/docs/dyn/cloudtrace_v1.projects.traces.html
@@ -78,7 +78,7 @@
<code><a href="#get">get(projectId, traceId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a single trace by its ID.</p>
<p class="toc_element">
- <code><a href="#list">list(projectId, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None, view=None)</a></code></p>
+ <code><a href="#list">list(projectId, orderBy=None, filter=None, endTime=None, pageToken=None, startTime=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns of a list of traces that match the specified filter conditions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -104,27 +104,19 @@
{ # A trace describes how long it takes for an application to perform an
# operation. It consists of a set of spans, each of which represent a single
# timed event within the operation.
- "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
- "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit
- # numeric value formatted as a 32-byte hex string. For example,
- # `382d4f4c6b7bb2f4a972559d9085001d`.
- "spans": [ # Collection of spans in the trace.
+ "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
+ "spans": [ # Collection of spans in the trace.
{ # A span represents a single timed event within a trace. Spans can be nested
# and form a trace tree. Often, a trace contains a root span that describes the
# end-to-end latency of an operation and, optionally, one or more subspans for
# its suboperations. Spans do not need to be contiguous. There may be gaps
# between spans in a trace.
- "kind": "A String", # Distinguishes between spans generated in a particular context. For example,
+ "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
+ "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
+ "kind": "A String", # Distinguishes between spans generated in a particular context. For example,
# two spans with the same name may be distinguished using `RPC_CLIENT`
# and `RPC_SERVER` to identify queueing latency associated with the span.
- "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized
- # and displayed in the Stackdriver Trace tool in the
- # Google Cloud Platform Console.
- # The name may be a method name or some other per-call site name.
- # For the same executable and the same call point, a best practice is
- # to use a consistent name, which makes it easier to correlate
- # cross-trace spans.
- "labels": { # Collection of labels associated with the span. Label keys must be less than
+ "labels": { # Collection of labels associated with the span. Label keys must be less than
# 128 bytes. Label values must be less than 16 kilobytes (10MB for
# `/stacktrace` values).
#
@@ -159,20 +151,28 @@
# * `/pid`
# * `/stacktrace`
# * `/tid`
- "a_key": "A String",
+ "a_key": "A String",
},
- "parentSpanId": "A String", # Optional. ID of the parent span, if any.
- "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
- "spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
+ "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized
+ # and displayed in the Stackdriver Trace tool in the
+ # Google Cloud Platform Console.
+ # The name may be a method name or some other per-call site name.
+ # For the same executable and the same call point, a best practice is
+ # to use a consistent name, which makes it easier to correlate
+ # cross-trace spans.
+ "spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
# unique within a trace. For example, `2205310701640571284`.
- "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
+ "parentSpanId": "A String", # Optional. ID of the parent span, if any.
},
],
+ "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit
+ # numeric value formatted as a 32-byte hex string. For example,
+ # `382d4f4c6b7bb2f4a972559d9085001d`.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(projectId, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None, view=None)</code>
+ <code class="details" id="list">list(projectId, orderBy=None, filter=None, endTime=None, pageToken=None, startTime=None, pageSize=None, view=None, x__xgafv=None)</code>
<pre>Returns of a list of traces that match the specified filter conditions.
In this case, listing for traces is considered an active developer method,
even though it is technically a read-only method.
@@ -192,17 +192,6 @@
(for example, `name desc`).
Only one sort field is permitted.
- startTime: string, Start of the time interval (inclusive) during which the trace data was
-collected from the application.
- pageSize: integer, Optional. Maximum number of traces to return. If not specified or <= 0, the
-implementation selects a reasonable value. The implementation may
-return fewer traces than the requested page size.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
- pageToken: string, Token identifying the page of results to return. If provided, use the
-value of the `next_page_token` field from a previous request.
filter: string, Optional. A filter against labels for the request.
By default, searches use prefix matching. To specify exact match, prepend
@@ -211,11 +200,11 @@
* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root
span starts with `NAME_PREFIX`.
-* `+root:NAME` or `+NAME`: Return traces where any root span's name is
+* `+root:NAME` or `+NAME`: Return traces where any root span's name is
exactly `NAME`.
* `span:NAME_PREFIX`: Return traces where any span starts with
`NAME_PREFIX`.
-* `+span:NAME`: Return traces where any span's name is exactly
+* `+span:NAME`: Return traces where any span's name is exactly
`NAME`.
* `latency:DURATION`: Return traces whose overall latency is
greater or equal to than `DURATION`. Accepted units are nanoseconds
@@ -224,7 +213,7 @@
is greater than or equal to 24 milliseconds.
* `label:LABEL_KEY`: Return all traces containing the specified
label key (exact match, case-sensitive) regardless of the key:value
- pair's value (including empty values).
+ pair's value (including empty values).
* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified
label key (exact match, case-sensitive) whose value starts with
`VALUE_PREFIX`. Both a key and a value must be specified.
@@ -235,41 +224,41 @@
* `url:VALUE`: Equivalent to `/http/url:VALUE`.
endTime: string, End of the time interval (inclusive) during which the trace data was
collected from the application.
+ pageToken: string, Token identifying the page of results to return. If provided, use the
+value of the `next_page_token` field from a previous request.
+ startTime: string, Start of the time interval (inclusive) during which the trace data was
+collected from the application.
+ pageSize: integer, Optional. Maximum number of traces to return. If not specified or <= 0, the
+implementation selects a reasonable value. The implementation may
+return fewer traces than the requested page size.
view: string, Optional. Type of data returned for traces in the list. Default is
`MINIMAL`.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # The response message for the `ListTraces` method.
- "nextPageToken": "A String", # If defined, indicates that there are more traces that match the request
- # and that this value should be passed to the next request to continue
- # retrieving additional traces.
- "traces": [ # List of trace records as specified by the view parameter.
+ "traces": [ # List of trace records as specified by the view parameter.
{ # A trace describes how long it takes for an application to perform an
# operation. It consists of a set of spans, each of which represent a single
# timed event within the operation.
- "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
- "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit
- # numeric value formatted as a 32-byte hex string. For example,
- # `382d4f4c6b7bb2f4a972559d9085001d`.
- "spans": [ # Collection of spans in the trace.
+ "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
+ "spans": [ # Collection of spans in the trace.
{ # A span represents a single timed event within a trace. Spans can be nested
# and form a trace tree. Often, a trace contains a root span that describes the
# end-to-end latency of an operation and, optionally, one or more subspans for
# its suboperations. Spans do not need to be contiguous. There may be gaps
# between spans in a trace.
- "kind": "A String", # Distinguishes between spans generated in a particular context. For example,
+ "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
+ "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
+ "kind": "A String", # Distinguishes between spans generated in a particular context. For example,
# two spans with the same name may be distinguished using `RPC_CLIENT`
# and `RPC_SERVER` to identify queueing latency associated with the span.
- "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized
- # and displayed in the Stackdriver Trace tool in the
- # Google Cloud Platform Console.
- # The name may be a method name or some other per-call site name.
- # For the same executable and the same call point, a best practice is
- # to use a consistent name, which makes it easier to correlate
- # cross-trace spans.
- "labels": { # Collection of labels associated with the span. Label keys must be less than
+ "labels": { # Collection of labels associated with the span. Label keys must be less than
# 128 bytes. Label values must be less than 16 kilobytes (10MB for
# `/stacktrace` values).
#
@@ -304,17 +293,28 @@
# * `/pid`
# * `/stacktrace`
# * `/tid`
- "a_key": "A String",
+ "a_key": "A String",
},
- "parentSpanId": "A String", # Optional. ID of the parent span, if any.
- "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
- "spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
+ "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized
+ # and displayed in the Stackdriver Trace tool in the
+ # Google Cloud Platform Console.
+ # The name may be a method name or some other per-call site name.
+ # For the same executable and the same call point, a best practice is
+ # to use a consistent name, which makes it easier to correlate
+ # cross-trace spans.
+ "spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
# unique within a trace. For example, `2205310701640571284`.
- "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
+ "parentSpanId": "A String", # Optional. ID of the parent span, if any.
},
],
+ "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit
+ # numeric value formatted as a 32-byte hex string. For example,
+ # `382d4f4c6b7bb2f4a972559d9085001d`.
},
],
+ "nextPageToken": "A String", # If defined, indicates that there are more traces that match the request
+ # and that this value should be passed to the next request to continue
+ # retrieving additional traces.
}</pre>
</div>
@@ -327,7 +327,7 @@
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
+ 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.
</pre>
</div>