Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / logging_v2beta1.projects.sinks.html
blob: 56d188b2b259ed585e02ff3c0b4714b82df13baf [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02: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
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]75<h1><a href="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.sinks.html">sinks</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[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 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>
Jon Wayne Parrott36e41bc2016-02-19 16:02: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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Gets a sink.</p>
86<p class="toc_element">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02: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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]93 <code><a href="#update">update(sinkName, body, uniqueWriterIdentity=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]97 <code class="details" id="create">create(parent, body, uniqueWriterIdentity=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[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 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]99
100Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]123 "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:
124 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
125 # resource.type=gce_instance
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]126 }
127
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]128 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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]129 x__xgafv: string, V1 error format.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]133
134Returns:
135 An object of the form:
136
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]137 { # 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]138 "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.
139 "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.
140 "destination": "A String", # Required. The export destination:
141 # "storage.googleapis.com/[GCS_BUCKET]"
142 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
143 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
144 # 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.
145 "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:
146 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
147 "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.
148 "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.
149 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]150 "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:
151 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
152 # resource.type=gce_instance
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 }</pre>
154</div>
155
156<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]157 <code class="details" id="delete">delete(sinkName, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]158 <pre>Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]159
160Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]161 sinkName: string, Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:
162"projects/[PROJECT_ID]/sinks/[SINK_ID]"
163"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]164"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
165"folders/[FOLDER_ID]/sinks/[SINK_ID]"
166Example: "projects/my-project-id/sinks/my-sink-id". (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]167 x__xgafv: string, V1 error format.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]171
172Returns:
173 An object of the form:
174
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]175 { # 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:
176 # service Foo {
177 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
178 # }
179 # The JSON representation for Empty is empty JSON object {}.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]180 }</pre>
181</div>
182
183<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]184 <code class="details" id="get">get(sinkName, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]185 <pre>Gets a sink.
186
187Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]188 sinkName: string, Required. The resource name of the sink:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]189"projects/[PROJECT_ID]/sinks/[SINK_ID]"
190"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]191"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
192"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]193Example: "projects/my-project-id/sinks/my-sink-id". (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]194 x__xgafv: string, V1 error format.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]198
199Returns:
200 An object of the form:
201
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]202 { # 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]203 "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.
204 "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.
205 "destination": "A String", # Required. The export destination:
206 # "storage.googleapis.com/[GCS_BUCKET]"
207 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
208 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
209 # 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.
210 "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:
211 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
212 "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.
213 "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.
214 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]215 "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:
216 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
217 # resource.type=gce_instance
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]218 }</pre>
219</div>
220
221<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]222 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]223 <pre>Lists sinks.
224
225Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]226 parent: string, Required. The parent resource whose sinks are to be listed:
227"projects/[PROJECT_ID]"
228"organizations/[ORGANIZATION_ID]"
229"billingAccounts/[BILLING_ACCOUNT_ID]"
230"folders/[FOLDER_ID]"
231 (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]232 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]233 x__xgafv: string, V1 error format.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]237 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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]238
239Returns:
240 An object of the form:
241
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]242 { # Result returned from ListSinks.
243 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]244 "sinks": [ # A list of sinks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]245 { # 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]246 "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.
247 "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.
248 "destination": "A String", # Required. The export destination:
249 # "storage.googleapis.com/[GCS_BUCKET]"
250 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
251 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
252 # 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.
253 "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:
254 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
255 "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.
256 "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.
257 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]258 "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:
259 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
260 # resource.type=gce_instance
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]261 },
262 ],
263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
268 <pre>Retrieves the next page of results.
269
270Args:
271 previous_request: The request for the previous page. (required)
272 previous_response: The response from the request for the previous page. (required)
273
274Returns:
275 A request object that you can call 'execute()' on to request the next
276 page. Returns None if there are no more items in the collection.
277 </pre>
278</div>
279
280<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]281 <code class="details" id="update">update(sinkName, body, uniqueWriterIdentity=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]282 <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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]283
284Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]285 sinkName: string, Required. The full resource name of the sink to update, including the parent resource and the sink identifier:
286"projects/[PROJECT_ID]/sinks/[SINK_ID]"
287"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]288"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
289"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]290Example: "projects/my-project-id/sinks/my-sink-id". (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]291 body: object, The request body. (required)
292 The object takes the form of:
293
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]294{ # 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]295 "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.
296 "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.
297 "destination": "A String", # Required. The export destination:
298 # "storage.googleapis.com/[GCS_BUCKET]"
299 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
300 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
301 # 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.
302 "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:
303 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
304 "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.
305 "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.
306 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]307 "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:
308 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
309 # resource.type=gce_instance
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]310 }
311
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]312 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:
313If 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]314If the old value is false and the new value is true, then writer_identity is changed to a unique service account.
315It is an error if the old value is true and the new value is false.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]316 x__xgafv: string, V1 error format.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]317 Allowed values
318 1 - v1 error format
319 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]320
321Returns:
322 An object of the form:
323
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]324 { # 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]325 "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.
326 "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.
327 "destination": "A String", # Required. The export destination:
328 # "storage.googleapis.com/[GCS_BUCKET]"
329 # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
330 # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
331 # 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.
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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
333 # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
334 "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.
335 "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.
336 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]337 "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:
338 # logName:("projects/test-project1/" OR "projects/test-project2/") AND
339 # resource.type=gce_instance
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]340 }</pre>
341</div>
342
343</body></html>