Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / logging_v2.billingAccounts.sinks.html
blob: d2e93be0411038553246d1faa1c969e541a1d464 [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.billingAccounts.html">billingAccounts</a> . <a href="logging_v2.billingAccounts.sinks.html">sinks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent=None, body, uniqueWriterIdentity=None, x__xgafv=None)</a></code></p>
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 current time is outside the sink's start and end times or 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>
80<p class="toc_element">
81 <code><a href="#delete">delete(sinkName=None, x__xgafv=None)</a></code></p>
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">
84 <code><a href="#get">get(sinkName=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a sink.</p>
86<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]87 <code><a href="#list">list(parent=None, 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">
93 <code><a href="#update">update(sinkName=None, body, uniqueWriterIdentity=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(parent=None, body, uniqueWriterIdentity=None, x__xgafv=None)</code>
98 <pre>Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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.
99
100Args:
101 parent: string, Required. The resource in which to create the sink:
102"projects/[PROJECT_ID]"
103"organizations/[ORGANIZATION_ID]"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]104"billingAccounts/[BILLING_ACCOUNT_ID]"
105"folders/[FOLDER_ID]"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]106Examples: "projects/my-logging-project", "organizations/123456789". (required)
107 body: object, The request body. (required)
108 The object takes the form of:
109
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]110{ # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]111 "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
112 "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.
113 "destination": "A String", # Required. The export destination:
114 # "storage.googleapis.com/[GCS_BUCKET]"
115 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
116 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
117 # 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.
118 "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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
119 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
120 "startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
121 "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
122 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting 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.
123 }
124
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]125 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 Stackdriver 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]126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131Returns:
132 An object of the form:
133
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]134 { # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]135 "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
136 "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.
137 "destination": "A String", # Required. The export destination:
138 # "storage.googleapis.com/[GCS_BUCKET]"
139 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
140 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
141 # 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.
142 "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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
143 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
144 "startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
145 "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
146 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting 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.
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="delete">delete(sinkName=None, x__xgafv=None)</code>
152 <pre>Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
153
154Args:
155 sinkName: string, Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:
156"projects/[PROJECT_ID]/sinks/[SINK_ID]"
157"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]158"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
159"folders/[FOLDER_ID]/sinks/[SINK_ID]"
160Example: "projects/my-project-id/sinks/my-sink-id". (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]161 x__xgafv: string, V1 error format.
162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
165
166Returns:
167 An object of the form:
168
169 { # 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:
170 # service Foo {
171 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
172 # }
173 # The JSON representation for Empty is empty JSON object {}.
174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="get">get(sinkName=None, x__xgafv=None)</code>
179 <pre>Gets a sink.
180
181Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]182 sinkName: string, Required. The resource name of the sink:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]183"projects/[PROJECT_ID]/sinks/[SINK_ID]"
184"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]185"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
186"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]187Example: "projects/my-project-id/sinks/my-sink-id". (required)
188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193Returns:
194 An object of the form:
195
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]196 { # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]197 "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
198 "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.
199 "destination": "A String", # Required. The export destination:
200 # "storage.googleapis.com/[GCS_BUCKET]"
201 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
202 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
203 # 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.
204 "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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
205 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
206 "startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
207 "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
208 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting 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.
209 }</pre>
210</div>
211
212<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]213 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]214 <pre>Lists sinks.
215
216Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]217 parent: string, Required. The parent resource whose sinks are to be listed:
218"projects/[PROJECT_ID]"
219"organizations/[ORGANIZATION_ID]"
220"billingAccounts/[BILLING_ACCOUNT_ID]"
221"folders/[FOLDER_ID]"
222 (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]223 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.
224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
228 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.
229
230Returns:
231 An object of the form:
232
233 { # Result returned from ListSinks.
234 "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.
235 "sinks": [ # A list of sinks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]236 { # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]237 "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
238 "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.
239 "destination": "A String", # Required. The export destination:
240 # "storage.googleapis.com/[GCS_BUCKET]"
241 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
242 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
243 # 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.
244 "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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
245 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
246 "startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
247 "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
248 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting 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.
249 },
250 ],
251 }</pre>
252</div>
253
254<div class="method">
255 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
256 <pre>Retrieves the next page of results.
257
258Args:
259 previous_request: The request for the previous page. (required)
260 previous_response: The response from the request for the previous page. (required)
261
262Returns:
263 A request object that you can call 'execute()' on to request the next
264 page. Returns None if there are no more items in the collection.
265 </pre>
266</div>
267
268<div class="method">
269 <code class="details" id="update">update(sinkName=None, body, uniqueWriterIdentity=None, x__xgafv=None)</code>
270 <pre>Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.
271
272Args:
273 sinkName: string, Required. The full resource name of the sink to update, including the parent resource and the sink identifier:
274"projects/[PROJECT_ID]/sinks/[SINK_ID]"
275"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]276"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
277"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]278Example: "projects/my-project-id/sinks/my-sink-id". (required)
279 body: object, The request body. (required)
280 The object takes the form of:
281
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]282{ # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]283 "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
284 "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.
285 "destination": "A String", # Required. The export destination:
286 # "storage.googleapis.com/[GCS_BUCKET]"
287 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
288 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
289 # 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.
290 "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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
291 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
292 "startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
293 "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
294 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting 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.
295 }
296
297 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:
298If 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]299If the old value is false and the new value is true, then writer_identity is changed to a unique service account.
300It is an error if the old value is true and the new value is false.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]301 x__xgafv: string, V1 error format.
302 Allowed values
303 1 - v1 error format
304 2 - v2 error format
305
306Returns:
307 An object of the form:
308
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]309 { # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]310 "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
311 "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.
312 "destination": "A String", # Required. The export destination:
313 # "storage.googleapis.com/[GCS_BUCKET]"
314 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
315 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
316 # 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.
317 "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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
318 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
319 "startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
320 "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
321 "writerIdentity": "A String", # Output only. An IAM identity&mdash;a service account or group&mdash;under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting 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.
322 }</pre>
323</div>
324
325</body></html>