Debian Codegraph @

docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
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>
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">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
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()</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>
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>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
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;).
107
108 Args:
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)
110 body: object, The request body.
111 The object takes the form of:
112
113 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
114 &quot;name&quot;: &quot;A String&quot;, # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[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.
115 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
116 &quot;destination&quot;: &quot;A String&quot;, # Required. The destination for writing trace data. Supported formats include: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
117 },
118 &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 to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;[email protected]&quot;
119 }
120
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126 Returns:
127 An object of the form:
128
129 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
130 &quot;name&quot;: &quot;A String&quot;, # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[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.
131 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
132 &quot;destination&quot;: &quot;A String&quot;, # Required. The destination for writing trace data. Supported formats include: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
133 },
134 &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 to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;[email protected]&quot;
135 }</pre>
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
142 Args:
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)
144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149 Returns:
150 An object of the form:
151
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); }
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
160 Args:
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)
162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166
167 Returns:
168 An object of the form:
169
170 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
171 &quot;name&quot;: &quot;A String&quot;, # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[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.
172 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
173 &quot;destination&quot;: &quot;A String&quot;, # Required. The destination for writing trace data. Supported formats include: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
174 },
175 &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 to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;[email protected]&quot;
176 }</pre>
177 </div>
178
179 <div class="method">
180 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
181 <pre>List all sinks for the parent resource (GCP project).
182
183 Args:
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)
185 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.
186 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.
187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192 Returns:
193 An object of the form:
194
195 { # Result returned from `ListTraceSinks`.
196 &quot;nextPageToken&quot;: &quot;A String&quot;, # A paginated response where more pages might be available has `next_page_token` set. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`.
197 &quot;sinks&quot;: [ # A list of sinks.
198 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
199 &quot;name&quot;: &quot;A String&quot;, # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[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.
200 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
201 &quot;destination&quot;: &quot;A String&quot;, # Required. The destination for writing trace data. Supported formats include: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
202 },
203 &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 to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;[email protected]&quot;
204 },
205 ],
206 }</pre>
207 </div>
208
209 <div class="method">
210 <code class="details" id="list_next">list_next()</code>
211 <pre>Retrieves the next page of results.
212
213 Args:
214 previous_request: The request for the previous page. (required)
215 previous_response: The response from the request for the previous page. (required)
216
217 Returns:
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>
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).
226
227 Args:
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)
229 body: object, The request body.
230 The object takes the form of:
231
232 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
233 &quot;name&quot;: &quot;A String&quot;, # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[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.
234 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
235 &quot;destination&quot;: &quot;A String&quot;, # Required. The destination for writing trace data. Supported formats include: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
236 },
237 &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 to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;[email protected]&quot;
238 }
239
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 `update_mask` 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`.
241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
245
246 Returns:
247 An object of the form:
248
249 { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
250 &quot;name&quot;: &quot;A String&quot;, # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[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.
251 &quot;outputConfig&quot;: { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
252 &quot;destination&quot;: &quot;A String&quot;, # Required. The destination for writing trace data. Supported formats include: &quot;bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]&quot;
253 },
254 &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 to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: &quot;[email protected]&quot;
255 }</pre>
256 </div>
257
258 </body></html>