| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="observability_v1.html">Observability API</a> . <a href="observability_v1.projects.html">projects</a> . <a href="observability_v1.projects.locations.html">locations</a> . <a href="observability_v1.projects.locations.traceScopes.html">traceScopes</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, traceScopeId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create a new TraceScope.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a TraceScope.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get TraceScope resource.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List TraceScopes of a project in a particular location.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update a TraceScope.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, traceScopeId=None, x__xgafv=None)</code> |
| <pre>Create a new TraceScope. |
| |
| Args: |
| parent: string, Required. The full resource name of the location where the trace scope should be created projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A trace scope is a collection of resources whose traces are queried together. |
| "createTime": "A String", # Output only. The creation timestamp of the trace scope. |
| "description": "A String", # Optional. Describes this trace scope. The maximum length of the description is 8000 characters. |
| "name": "A String", # Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope |
| "resourceNames": [ # Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects. |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. The last update timestamp of the trace scope. |
| } |
| |
| traceScopeId: string, Required. A client-assigned identifier for the trace scope. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A trace scope is a collection of resources whose traces are queried together. |
| "createTime": "A String", # Output only. The creation timestamp of the trace scope. |
| "description": "A String", # Optional. Describes this trace scope. The maximum length of the description is 8000 characters. |
| "name": "A String", # Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope |
| "resourceNames": [ # Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects. |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. The last update timestamp of the trace scope. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Delete a TraceScope. |
| |
| Args: |
| name: string, Required. The full resource name of the trace scope to delete: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope (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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Get TraceScope resource. |
| |
| Args: |
| name: string, Required. The resource name of the trace scope: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A trace scope is a collection of resources whose traces are queried together. |
| "createTime": "A String", # Output only. The creation timestamp of the trace scope. |
| "description": "A String", # Optional. Describes this trace scope. The maximum length of the description is 8000 characters. |
| "name": "A String", # Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope |
| "resourceNames": [ # Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects. |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. The last update timestamp of the trace scope. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>List TraceScopes of a project in a particular location. |
| |
| Args: |
| parent: string, Required. The full resource name of the location to look for trace scopes: projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global (required) |
| pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. |
| pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` 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 |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for listing TraceScopes. |
| "nextPageToken": "A String", # Optional. If there might be more results than appear in this response, then `next_page_token` is included. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`. |
| "traceScopes": [ # Optional. A list of trace scopes. |
| { # A trace scope is a collection of resources whose traces are queried together. |
| "createTime": "A String", # Output only. The creation timestamp of the trace scope. |
| "description": "A String", # Optional. Describes this trace scope. The maximum length of the description is 8000 characters. |
| "name": "A String", # Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope |
| "resourceNames": [ # Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects. |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. The last update timestamp of the trace scope. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update a TraceScope. |
| |
| Args: |
| name: string, Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A trace scope is a collection of resources whose traces are queried together. |
| "createTime": "A String", # Output only. The creation timestamp of the trace scope. |
| "description": "A String", # Optional. Describes this trace scope. The maximum length of the description is 8000 characters. |
| "name": "A String", # Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope |
| "resourceNames": [ # Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects. |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. The last update timestamp of the trace scope. |
| } |
| |
| updateMask: string, Optional. The list of fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A trace scope is a collection of resources whose traces are queried together. |
| "createTime": "A String", # Output only. The creation timestamp of the trace scope. |
| "description": "A String", # Optional. Describes this trace scope. The maximum length of the description is 8000 characters. |
| "name": "A String", # Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope |
| "resourceNames": [ # Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects. |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. The last update timestamp of the trace scope. |
| }</pre> |
| </div> |
| |
| </body></html> |
