Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / logging_v2.sinks.html
blob: 2a2c62cfba8a8e93d69918a7cd6b985f19dc8b78 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]75<h1><a href="logging_v2.html">Cloud Logging API</a> . <a href="logging_v2.sinks.html">sinks</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(parent, body=None, 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>
80<p class="toc_element">
81 <code><a href="#delete">delete(sinkName, 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, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a sink.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#update">update(sinkName, body=None, uniqueWriterIdentity=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]97 <code class="details" id="create">create(parent, body=None, uniqueWriterIdentity=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <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.
99
100Args:
101 parent: string, Required. The resource in which to create the sink:
102"projects/[PROJECT_ID]"
103"organizations/[ORGANIZATION_ID]"
104"billingAccounts/[BILLING_ACCOUNT_ID]"
105"folders/[FOLDER_ID]"
106Examples: "projects/my-logging-project", "organizations/123456789". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]107 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 The object takes the form of:
109
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 "disabled": True or False, # Optional. If set to True, then this sink is disabled and it does not export any log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 "bigqueryOptions": { # Options that change functionality of a sink exporting data to BigQuery. # Optional. Options that affect sinks exporting data to BigQuery.
114 "usePartitionedTables": True or False, # Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
115 "usesTimestampColumnPartitioning": True or False, # Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.
116 },
117 "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. First character has to be alphanumeric.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 "destination": "A String", # Required. The export destination:
119 # "storage.googleapis.com/[GCS_BUCKET]"
120 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
121 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
122 # 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.
123 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
124 "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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity&gt;=ERROR
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 "writerIdentity": "A String", # Output only. An IAM identity&amp;mdash;a service account or group&amp;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 "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:
129 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
130 # resource.type=gce_instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 "description": "A String", # Optional. A description of this sink. The maximum length of the description is 8000 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132}
133
134 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.
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140Returns:
141 An object of the form:
142
143 { # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144 "disabled": True or False, # Optional. If set to True, then this sink is disabled and it does not export any log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]146 "bigqueryOptions": { # Options that change functionality of a sink exporting data to BigQuery. # Optional. Options that affect sinks exporting data to BigQuery.
147 "usePartitionedTables": True or False, # Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
148 "usesTimestampColumnPartitioning": True or False, # Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.
149 },
150 "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. First character has to be alphanumeric.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 "destination": "A String", # Required. The export destination:
152 # "storage.googleapis.com/[GCS_BUCKET]"
153 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
154 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
155 # 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.
156 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
157 "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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]158 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity&gt;=ERROR
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 "writerIdentity": "A String", # Output only. An IAM identity&amp;mdash;a service account or group&amp;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 "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:
162 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
163 # resource.type=gce_instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]164 "description": "A String", # Optional. A description of this sink. The maximum length of the description is 8000 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="delete">delete(sinkName, x__xgafv=None)</code>
170 <pre>Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
171
172Args:
173 sinkName: string, Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:
174"projects/[PROJECT_ID]/sinks/[SINK_ID]"
175"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
176"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
177"folders/[FOLDER_ID]/sinks/[SINK_ID]"
178Example: "projects/my-project-id/sinks/my-sink-id". (required)
179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
183
184Returns:
185 An object of the form:
186
187 { # 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:
188 # service Foo {
189 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
190 # }
191 # The JSON representation for Empty is empty JSON object {}.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="get">get(sinkName, x__xgafv=None)</code>
197 <pre>Gets a sink.
198
199Args:
200 sinkName: string, Required. The resource name of the sink:
201"projects/[PROJECT_ID]/sinks/[SINK_ID]"
202"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
203"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
204"folders/[FOLDER_ID]/sinks/[SINK_ID]"
205Example: "projects/my-project-id/sinks/my-sink-id". (required)
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210
211Returns:
212 An object of the form:
213
214 { # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]215 "disabled": True or False, # Optional. If set to True, then this sink is disabled and it does not export any log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]217 "bigqueryOptions": { # Options that change functionality of a sink exporting data to BigQuery. # Optional. Options that affect sinks exporting data to BigQuery.
218 "usePartitionedTables": True or False, # Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
219 "usesTimestampColumnPartitioning": True or False, # Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.
220 },
221 "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. First character has to be alphanumeric.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 "destination": "A String", # Required. The export destination:
223 # "storage.googleapis.com/[GCS_BUCKET]"
224 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
225 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
226 # 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.
227 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
228 "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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]229 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity&gt;=ERROR
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]231 "writerIdentity": "A String", # Output only. An IAM identity&amp;mdash;a service account or group&amp;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 "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:
233 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
234 # resource.type=gce_instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]235 "description": "A String", # Optional. A description of this sink. The maximum length of the description is 8000 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 }</pre>
237</div>
238
239<div class="method">
240 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
241 <pre>Lists sinks.
242
243Args:
244 parent: string, Required. The parent resource whose sinks are to be listed:
245"projects/[PROJECT_ID]"
246"organizations/[ORGANIZATION_ID]"
247"billingAccounts/[BILLING_ACCOUNT_ID]"
248"folders/[FOLDER_ID]"
249 (required)
250 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.
251 x__xgafv: string, V1 error format.
252 Allowed values
253 1 - v1 error format
254 2 - v2 error format
255 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.
256
257Returns:
258 An object of the form:
259
260 { # Result returned from ListSinks.
261 "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.
262 "sinks": [ # A list of sinks.
263 { # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 "disabled": True or False, # Optional. If set to True, then this sink is disabled and it does not export any log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]266 "bigqueryOptions": { # Options that change functionality of a sink exporting data to BigQuery. # Optional. Options that affect sinks exporting data to BigQuery.
267 "usePartitionedTables": True or False, # Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
268 "usesTimestampColumnPartitioning": True or False, # Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.
269 },
270 "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. First character has to be alphanumeric.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 "destination": "A String", # Required. The export destination:
272 # "storage.googleapis.com/[GCS_BUCKET]"
273 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
274 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
275 # 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.
276 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
277 "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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]278 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity&gt;=ERROR
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]280 "writerIdentity": "A String", # Output only. An IAM identity&amp;mdash;a service account or group&amp;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]281 "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:
282 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
283 # resource.type=gce_instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]284 "description": "A String", # Optional. A description of this sink. The maximum length of the description is 8000 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 },
286 ],
287 }</pre>
288</div>
289
290<div class="method">
291 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
292 <pre>Retrieves the next page of results.
293
294Args:
295 previous_request: The request for the previous page. (required)
296 previous_response: The response from the request for the previous page. (required)
297
298Returns:
299 A request object that you can call 'execute()' on to request the next
300 page. Returns None if there are no more items in the collection.
301 </pre>
302</div>
303
304<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]305 <code class="details" id="update">update(sinkName, body=None, uniqueWriterIdentity=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306 <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.
307
308Args:
309 sinkName: string, Required. The full resource name of the sink to update, including the parent resource and the sink identifier:
310"projects/[PROJECT_ID]/sinks/[SINK_ID]"
311"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
312"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
313"folders/[FOLDER_ID]/sinks/[SINK_ID]"
314Example: "projects/my-project-id/sinks/my-sink-id". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]315 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316 The object takes the form of:
317
318{ # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]319 "disabled": True or False, # Optional. If set to True, then this sink is disabled and it does not export any log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]321 "bigqueryOptions": { # Options that change functionality of a sink exporting data to BigQuery. # Optional. Options that affect sinks exporting data to BigQuery.
322 "usePartitionedTables": True or False, # Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
323 "usesTimestampColumnPartitioning": True or False, # Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.
324 },
325 "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. First character has to be alphanumeric.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326 "destination": "A String", # Required. The export destination:
327 # "storage.googleapis.com/[GCS_BUCKET]"
328 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
329 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
330 # 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.
331 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
332 "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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]333 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity&gt;=ERROR
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]335 "writerIdentity": "A String", # Output only. An IAM identity&amp;mdash;a service account or group&amp;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]336 "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:
337 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
338 # resource.type=gce_instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]339 "description": "A String", # Optional. A description of this sink. The maximum length of the description is 8000 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]340}
341
342 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:
343If 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.
344If the old value is false and the new value is true, then writer_identity is changed to a unique service account.
345It is an error if the old value is true and the new value is set to false or defaulted to false.
346 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.
347 x__xgafv: string, V1 error format.
348 Allowed values
349 1 - v1 error format
350 2 - v2 error format
351
352Returns:
353 An object of the form:
354
355 { # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]356 "disabled": True or False, # Optional. If set to True, then this sink is disabled and it does not export any log entries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]358 "bigqueryOptions": { # Options that change functionality of a sink exporting data to BigQuery. # Optional. Options that affect sinks exporting data to BigQuery.
359 "usePartitionedTables": True or False, # Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
360 "usesTimestampColumnPartitioning": True or False, # Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.
361 },
362 "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. First character has to be alphanumeric.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 "destination": "A String", # Required. The export destination:
364 # "storage.googleapis.com/[GCS_BUCKET]"
365 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
366 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
367 # 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.
368 "createTime": "A String", # Output only. The creation timestamp of the sink.This field may not be present for older sinks.
369 "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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]370 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity&gt;=ERROR
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]371 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]372 "writerIdentity": "A String", # Output only. An IAM identity&amp;mdash;a service account or group&amp;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]373 "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:
374 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
375 # resource.type=gce_instance
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]376 "description": "A String", # Optional. A description of this sink. The maximum length of the description is 8000 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]377 }</pre>
378</div>
379
380</body></html>