Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / logging_v2.folders.sinks.html
blob: 7ff6b75ebd7d02dd76d67c5edc0a2bfe1aadf59b [file] [log] [blame]
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.folders.html">folders</a> . <a href="logging_v2.folders.sinks.html">sinks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#create">create(parent, body, uniqueWriterIdentity=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#delete">delete(sinkName, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]82<p class="firstline">Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.</p>
83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#get">get(sinkName, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]85<p class="firstline">Gets a sink.</p>
86<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]88<p class="firstline">Lists sinks.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93 <code><a href="#patch">patch(sinkName, body, uniqueWriterIdentity=None, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.</p>
95<p class="toc_element">
96 <code><a href="#update">update(sinkName, body, uniqueWriterIdentity=None, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]100 <code class="details" id="create">create(parent, body, uniqueWriterIdentity=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101 <pre>Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]102
103Args:
104 parent: string, Required. The resource in which to create the sink:
105"projects/[PROJECT_ID]"
106"organizations/[ORGANIZATION_ID]"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107"billingAccounts/[BILLING_ACCOUNT_ID]"
108"folders/[FOLDER_ID]"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]109Examples: "projects/my-logging-project", "organizations/123456789". (required)
110 body: object, The request body. (required)
111 The object takes the form of:
112
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
114 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
115 "name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
116 "destination": "A String", # Required. The export destination:
117 # "storage.googleapis.com/[GCS_BUCKET]"
118 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
119 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
120 # The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
121 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
122 "filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:
123 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
124 "outputVersionFormat": "A String", # Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
125 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
126 "includeChildren": True or False, # Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:
127 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
128 # resource.type=gce_instance
129}
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]130
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 uniqueWriterIdentity: boolean, Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 { # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
141 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
142 "name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
143 "destination": "A String", # Required. The export destination:
144 # "storage.googleapis.com/[GCS_BUCKET]"
145 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
146 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
147 # The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
148 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
149 "filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:
150 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
151 "outputVersionFormat": "A String", # Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
152 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
153 "includeChildren": True or False, # Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:
154 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
155 # resource.type=gce_instance
156 }</pre>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]157</div>
158
159<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]160 <code class="details" id="delete">delete(sinkName, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]161 <pre>Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
162
163Args:
164 sinkName: string, Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:
165"projects/[PROJECT_ID]/sinks/[SINK_ID]"
166"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
168"folders/[FOLDER_ID]/sinks/[SINK_ID]"
169Example: "projects/my-project-id/sinks/my-sink-id". (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]170 x__xgafv: string, V1 error format.
171 Allowed values
172 1 - v1 error format
173 2 - v2 error format
174
175Returns:
176 An object of the form:
177
178 { # 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:
179 # service Foo {
180 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
181 # }
182 # The JSON representation for Empty is empty JSON object {}.
183 }</pre>
184</div>
185
186<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]187 <code class="details" id="get">get(sinkName, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]188 <pre>Gets a sink.
189
190Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 sinkName: string, Required. The resource name of the sink:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]192"projects/[PROJECT_ID]/sinks/[SINK_ID]"
193"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
195"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]196Example: "projects/my-project-id/sinks/my-sink-id". (required)
197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
201
202Returns:
203 An object of the form:
204
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 { # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
206 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
207 "name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
208 "destination": "A String", # Required. The export destination:
209 # "storage.googleapis.com/[GCS_BUCKET]"
210 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
211 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
212 # The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
213 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
214 "filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:
215 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
216 "outputVersionFormat": "A String", # Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
217 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
218 "includeChildren": True or False, # Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:
219 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
220 # resource.type=gce_instance
221 }</pre>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]222</div>
223
224<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]225 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]226 <pre>Lists sinks.
227
228Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 parent: string, Required. The parent resource whose sinks are to be listed:
230"projects/[PROJECT_ID]"
231"organizations/[ORGANIZATION_ID]"
232"billingAccounts/[BILLING_ACCOUNT_ID]"
233"folders/[FOLDER_ID]"
234 (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]235 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.
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]240 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]241
242Returns:
243 An object of the form:
244
245 { # Result returned from ListSinks.
246 "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 the same method again using the value of nextPageToken as pageToken.
247 "sinks": [ # A list of sinks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 { # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
249 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
250 "name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
251 "destination": "A String", # Required. The export destination:
252 # "storage.googleapis.com/[GCS_BUCKET]"
253 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
254 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
255 # The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
256 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
257 "filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:
258 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
259 "outputVersionFormat": "A String", # Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
260 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
261 "includeChildren": True or False, # Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:
262 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
263 # resource.type=gce_instance
264 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]265 ],
266 }</pre>
267</div>
268
269<div class="method">
270 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
271 <pre>Retrieves the next page of results.
272
273Args:
274 previous_request: The request for the previous page. (required)
275 previous_response: The response from the request for the previous page. (required)
276
277Returns:
278 A request object that you can call 'execute()' on to request the next
279 page. Returns None if there are no more items in the collection.
280 </pre>
281</div>
282
283<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 <code class="details" id="patch">patch(sinkName, body, uniqueWriterIdentity=None, updateMask=None, x__xgafv=None)</code>
285 <pre>Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]286
287Args:
288 sinkName: string, Required. The full resource name of the sink to update, including the parent resource and the sink identifier:
289"projects/[PROJECT_ID]/sinks/[SINK_ID]"
290"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
292"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]293Example: "projects/my-project-id/sinks/my-sink-id". (required)
294 body: object, The request body. (required)
295 The object takes the form of:
296
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
298 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
299 "name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
300 "destination": "A String", # Required. The export destination:
301 # "storage.googleapis.com/[GCS_BUCKET]"
302 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
303 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
304 # The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
305 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
306 "filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:
307 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
308 "outputVersionFormat": "A String", # Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
309 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
310 "includeChildren": True or False, # Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:
311 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
312 # resource.type=gce_instance
313}
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]314
315 uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:
316If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317If the old value is false and the new value is true, then writer_identity is changed to a unique service account.
318It is an error if the old value is true and the new value is set to false or defaulted to false.
319 updateMask: string, Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]320 x__xgafv: string, V1 error format.
321 Allowed values
322 1 - v1 error format
323 2 - v2 error format
324
325Returns:
326 An object of the form:
327
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 { # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
329 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
330 "name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
331 "destination": "A String", # Required. The export destination:
332 # "storage.googleapis.com/[GCS_BUCKET]"
333 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
334 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
335 # The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
336 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
337 "filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:
338 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
339 "outputVersionFormat": "A String", # Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
340 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
341 "includeChildren": True or False, # Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:
342 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
343 # resource.type=gce_instance
344 }</pre>
345</div>
346
347<div class="method">
348 <code class="details" id="update">update(sinkName, body, uniqueWriterIdentity=None, updateMask=None, x__xgafv=None)</code>
349 <pre>Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
350
351Args:
352 sinkName: string, Required. The full resource name of the sink to update, including the parent resource and the sink identifier:
353"projects/[PROJECT_ID]/sinks/[SINK_ID]"
354"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
355"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
356"folders/[FOLDER_ID]/sinks/[SINK_ID]"
357Example: "projects/my-project-id/sinks/my-sink-id". (required)
358 body: object, The request body. (required)
359 The object takes the form of:
360
361{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
362 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
363 "name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
364 "destination": "A String", # Required. The export destination:
365 # "storage.googleapis.com/[GCS_BUCKET]"
366 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
367 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
368 # The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
369 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
370 "filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:
371 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
372 "outputVersionFormat": "A String", # Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
373 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
374 "includeChildren": True or False, # Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:
375 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
376 # resource.type=gce_instance
377}
378
379 uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:
380If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.
381If the old value is false and the new value is true, then writer_identity is changed to a unique service account.
382It is an error if the old value is true and the new value is set to false or defaulted to false.
383 updateMask: string, Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.
384 x__xgafv: string, V1 error format.
385 Allowed values
386 1 - v1 error format
387 2 - v2 error format
388
389Returns:
390 An object of the form:
391
392 { # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
393 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
394 "name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
395 "destination": "A String", # Required. The export destination:
396 # "storage.googleapis.com/[GCS_BUCKET]"
397 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
398 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
399 # The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
400 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
401 "filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:
402 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
403 "outputVersionFormat": "A String", # Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
404 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
405 "includeChildren": True or False, # Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:
406 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
407 # resource.type=gce_instance
408 }</pre>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]409</div>
410
411</body></html>