Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / cloudtrace_v2beta1.projects.traceSinks.html
blob: 154a98af5b8cecacffe2805fa76745e2dce915b7 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudtrace_v2beta1.html">Cloud Trace API</a> . <a href="cloudtrace_v2beta1.projects.html">projects</a> . <a href="cloudtrace_v2beta1.projects.traceSinks.html">traceSinks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a sink that exports trace spans to a destination. The export of newly-ingested traces begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export traces only from the resource owning the sink (the 'parent').</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a sink.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Get a trace sink by name under the parent resource (GCP project).</p>
89<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]91<p class="firstline">List all sinks for the parent resource (GCP project).</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="firstline">Updates a sink. This method updates fields in the existing sink according to the provided update mask. The sink's name cannot be changed nor any output-only fields (e.g. the writer_identity).</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106 <pre>Creates a sink that exports trace spans to a destination. The export of newly-ingested traces begins immediately, unless the sink&#x27;s `writer_identity` is not permitted to write to the destination. A sink can export traces only from the resource owning the sink (the &#x27;parent&#x27;).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107
108Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 parent: string, Required. The resource in which to create the sink (currently only project sinks are supported): &quot;projects/[PROJECT_ID]&quot; Examples: `&quot;projects/my-trace-project&quot;`, `&quot;projects/123456789&quot;`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 body: object, The request body.
111 The object takes the form of:
112
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]113{ # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]114 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
115 &quot;destination&quot;: &quot;A String&quot;, # The destination for writing trace data. Currently only BigQuery is supported. E.g.: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
116 },
117 &quot;writerIdentity&quot;: &quot;A String&quot;, # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and write data this account will need the dataEditor role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;service-00000001@00000002.iam.gserviceaccount.com&quot;
118 &quot;name&quot;: &quot;A String&quot;, # Required. The canonical sink resource name, unique within the project. Must be of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `&quot;projects/12345/traceSinks/my-project-trace-sink&quot;`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
119}
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]120
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126Returns:
127 An object of the form:
128
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]130 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
131 &quot;destination&quot;: &quot;A String&quot;, # The destination for writing trace data. Currently only BigQuery is supported. E.g.: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
132 },
133 &quot;writerIdentity&quot;: &quot;A String&quot;, # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and write data this account will need the dataEditor role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;service-00000001@00000002.iam.gserviceaccount.com&quot;
134 &quot;name&quot;: &quot;A String&quot;, # Required. The canonical sink resource name, unique within the project. Must be of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `&quot;projects/12345/traceSinks/my-project-trace-sink&quot;`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
135 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136</div>
137
138<div class="method">
139 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
140 <pre>Deletes a sink.
141
142Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]143 name: string, Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: &quot;projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]&quot; Example: `&quot;projects/12345/traceSinks/my-sink-id&quot;`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149Returns:
150 An object of the form:
151
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]152 { # 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 `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="get">get(name, x__xgafv=None)</code>
158 <pre>Get a trace sink by name under the parent resource (GCP project).
159
160Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]161 name: string, Required. The resource name of the sink: &quot;projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]&quot; Example: `&quot;projects/12345/traceSinks/my-sink-id&quot;`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166
167Returns:
168 An object of the form:
169
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]170 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]171 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
172 &quot;destination&quot;: &quot;A String&quot;, # The destination for writing trace data. Currently only BigQuery is supported. E.g.: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
173 },
174 &quot;writerIdentity&quot;: &quot;A String&quot;, # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and write data this account will need the dataEditor role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;service-00000001@00000002.iam.gserviceaccount.com&quot;
175 &quot;name&quot;: &quot;A String&quot;, # Required. The canonical sink resource name, unique within the project. Must be of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `&quot;projects/12345/traceSinks/my-project-trace-sink&quot;`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
176 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177</div>
178
179<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]180 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 <pre>List all sinks for the parent resource (GCP project).
182
183Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]184 parent: string, Required. The parent resource whose sinks are to be listed (currently only project parent resources are supported): &quot;projects/[PROJECT_ID]&quot; (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]185 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]186 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192Returns:
193 An object of the form:
194
195 { # Result returned from `ListTraceSinks`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]196 &quot;nextPageToken&quot;: &quot;A String&quot;, # If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]197 &quot;sinks&quot;: [ # A list of sinks.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]198 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]199 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
200 &quot;destination&quot;: &quot;A String&quot;, # The destination for writing trace data. Currently only BigQuery is supported. E.g.: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]201 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]202 &quot;writerIdentity&quot;: &quot;A String&quot;, # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and write data this account will need the dataEditor role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;service-00000001@00000002.iam.gserviceaccount.com&quot;
203 &quot;name&quot;: &quot;A String&quot;, # Required. The canonical sink resource name, unique within the project. Must be of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `&quot;projects/12345/traceSinks/my-project-trace-sink&quot;`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
204 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]205 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 }</pre>
207</div>
208
209<div class="method">
210 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
211 <pre>Retrieves the next page of results.
212
213Args:
214 previous_request: The request for the previous page. (required)
215 previous_response: The response from the request for the previous page. (required)
216
217Returns:
218 A request object that you can call &#x27;execute()&#x27; on to request the next
219 page. Returns None if there are no more items in the collection.
220 </pre>
221</div>
222
223<div class="method">
224 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]225 <pre>Updates a sink. This method updates fields in the existing sink according to the provided update mask. The sink&#x27;s name cannot be changed nor any output-only fields (e.g. the writer_identity).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226
227Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]228 name: string, Required. The full resource name of the sink to update, including the parent resource and the sink identifier: &quot;projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]&quot; Example: `&quot;projects/12345/traceSinks/my-sink-id&quot;`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 body: object, The request body.
230 The object takes the form of:
231
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]232{ # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]233 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
234 &quot;destination&quot;: &quot;A String&quot;, # The destination for writing trace data. Currently only BigQuery is supported. E.g.: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
235 },
236 &quot;writerIdentity&quot;: &quot;A String&quot;, # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and write data this account will need the dataEditor role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;service-00000001@00000002.iam.gserviceaccount.com&quot;
237 &quot;name&quot;: &quot;A String&quot;, # Required. The canonical sink resource name, unique within the project. Must be of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `&quot;projects/12345/traceSinks/my-project-trace-sink&quot;`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
238}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]240 updateMask: string, Required. Field mask that specifies the fields in `trace_sink` that are to be updated. A sink field is overwritten if, and only if, it is in the update mask. `name` and `writer_identity` fields cannot be updated. An empty updateMask is considered an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Example: `updateMask=output_config`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
245
246Returns:
247 An object of the form:
248
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]249 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]250 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
251 &quot;destination&quot;: &quot;A String&quot;, # The destination for writing trace data. Currently only BigQuery is supported. E.g.: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
252 },
253 &quot;writerIdentity&quot;: &quot;A String&quot;, # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and write data this account will need the dataEditor role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;service-00000001@00000002.iam.gserviceaccount.com&quot;
254 &quot;name&quot;: &quot;A String&quot;, # Required. The canonical sink resource name, unique within the project. Must be of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `&quot;projects/12345/traceSinks/my-project-trace-sink&quot;`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
255 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]256</div>
257
258</body></html>