Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
Sai Cheemalapati | ea3a5e1 | 2016-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 Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 78 | <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 79 | <p class="firstline">Creates a sink.</p> |
| 80 | <p class="toc_element"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 81 | <code><a href="#delete">delete(sinkName=None, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 82 | <p class="firstline">Deletes a sink.</p> |
| 83 | <p class="toc_element"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 84 | <code><a href="#get">get(sinkName=None, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 85 | <p class="firstline">Gets a sink.</p> |
| 86 | <p class="toc_element"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p> |
Jon Wayne Parrott | 36e41bc | 2016-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"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 93 | <code><a href="#update">update(sinkName=None, body, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Updates or creates a sink.</p> |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 97 | <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code> |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 98 | <pre>Creates a sink. |
| 99 | |
| 100 | Args: |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 101 | parent: string, Required. The resource in which to create the sink. |
| 102 | Example: `"projects/my-project-id"`. |
| 103 | The new sink must be provided in the request. (required) |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 104 | body: object, The request body. (required) |
| 105 | The object takes the form of: |
| 106 | |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 107 | { # Describes a sink used to export log entries outside Stackdriver Logging. |
| 108 | "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). |
| 109 | # Only log entries matching the filter are exported. The filter |
| 110 | # must be consistent with the log entry format specified by the |
| 111 | # `outputVersionFormat` parameter, regardless of the format of the |
| 112 | # log entry that was originally written to Stackdriver Logging. |
| 113 | # Example filter (V2 format): |
| 114 | # |
| 115 | # logName=projects/my-projectid/logs/syslog AND severity>=ERROR |
| 116 | "destination": "A String", # Required. The export destination. See |
| 117 | # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). |
| 118 | # Examples: |
| 119 | # |
| 120 | # "storage.googleapis.com/my-gcs-bucket" |
| 121 | # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" |
| 122 | # "pubsub.googleapis.com/projects/my-project/topics/my-topic" |
| 123 | "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write |
| 124 | # access. This may be a service account or a group. |
| 125 | # Examples (Do not assume these specific values): |
| 126 | # "serviceAccount:cloud-logs@system.gserviceaccount.com" |
| 127 | # "group:cloud-logs@google.com" |
| 128 | # |
| 129 | # For GCS destinations, the role "roles/owner" is required on the bucket |
| 130 | # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is |
| 131 | # required on the topic |
| 132 | # For BigQuery, the role "roles/editor" is required on the dataset |
| 133 | "name": "A String", # Required. The client-assigned sink identifier, unique within the |
| 134 | # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are |
| 135 | # limited to 1000 characters and can include only the following characters: |
| 136 | # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length |
| 137 | # of the name is 100 characters. |
| 138 | "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log |
| 139 | # entries. This version does not have to correspond to the version of the |
| 140 | # log entry that was written to Stackdriver Logging. If omitted, the |
| 141 | # v2 format is used. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 145 | Allowed values |
| 146 | 1 - v1 error format |
| 147 | 2 - v2 error format |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 152 | { # Describes a sink used to export log entries outside Stackdriver Logging. |
| 153 | "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). |
| 154 | # Only log entries matching the filter are exported. The filter |
| 155 | # must be consistent with the log entry format specified by the |
| 156 | # `outputVersionFormat` parameter, regardless of the format of the |
| 157 | # log entry that was originally written to Stackdriver Logging. |
| 158 | # Example filter (V2 format): |
| 159 | # |
| 160 | # logName=projects/my-projectid/logs/syslog AND severity>=ERROR |
| 161 | "destination": "A String", # Required. The export destination. See |
| 162 | # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). |
| 163 | # Examples: |
| 164 | # |
| 165 | # "storage.googleapis.com/my-gcs-bucket" |
| 166 | # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" |
| 167 | # "pubsub.googleapis.com/projects/my-project/topics/my-topic" |
| 168 | "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write |
| 169 | # access. This may be a service account or a group. |
| 170 | # Examples (Do not assume these specific values): |
| 171 | # "serviceAccount:cloud-logs@system.gserviceaccount.com" |
| 172 | # "group:cloud-logs@google.com" |
| 173 | # |
| 174 | # For GCS destinations, the role "roles/owner" is required on the bucket |
| 175 | # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is |
| 176 | # required on the topic |
| 177 | # For BigQuery, the role "roles/editor" is required on the dataset |
| 178 | "name": "A String", # Required. The client-assigned sink identifier, unique within the |
| 179 | # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are |
| 180 | # limited to 1000 characters and can include only the following characters: |
| 181 | # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length |
| 182 | # of the name is 100 characters. |
| 183 | "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log |
| 184 | # entries. This version does not have to correspond to the version of the |
| 185 | # log entry that was written to Stackdriver Logging. If omitted, the |
| 186 | # v2 format is used. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 187 | }</pre> |
| 188 | </div> |
| 189 | |
| 190 | <div class="method"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 191 | <code class="details" id="delete">delete(sinkName=None, x__xgafv=None)</code> |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 192 | <pre>Deletes a sink. |
| 193 | |
| 194 | Args: |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 195 | sinkName: string, Required. The resource name of the sink to delete, including the parent |
| 196 | resource and the sink identifier. Example: |
| 197 | `"projects/my-project-id/sinks/my-sink-id"`. It is an error if the sink |
| 198 | does not exist. (required) |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 199 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 200 | Allowed values |
| 201 | 1 - v1 error format |
| 202 | 2 - v2 error format |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 203 | |
| 204 | Returns: |
| 205 | An object of the form: |
| 206 | |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 207 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 208 | # empty messages in your APIs. A typical example is to use it as the request |
| 209 | # or the response type of an API method. For instance: |
| 210 | # |
| 211 | # service Foo { |
| 212 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 213 | # } |
| 214 | # |
| 215 | # The JSON representation for `Empty` is empty JSON object `{}`. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 216 | }</pre> |
| 217 | </div> |
| 218 | |
| 219 | <div class="method"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 220 | <code class="details" id="get">get(sinkName=None, x__xgafv=None)</code> |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 221 | <pre>Gets a sink. |
| 222 | |
| 223 | Args: |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 224 | sinkName: string, Required. The resource name of the sink to return. |
| 225 | Example: `"projects/my-project-id/sinks/my-sink-id"`. (required) |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 226 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 227 | Allowed values |
| 228 | 1 - v1 error format |
| 229 | 2 - v2 error format |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 230 | |
| 231 | Returns: |
| 232 | An object of the form: |
| 233 | |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 234 | { # Describes a sink used to export log entries outside Stackdriver Logging. |
| 235 | "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). |
| 236 | # Only log entries matching the filter are exported. The filter |
| 237 | # must be consistent with the log entry format specified by the |
| 238 | # `outputVersionFormat` parameter, regardless of the format of the |
| 239 | # log entry that was originally written to Stackdriver Logging. |
| 240 | # Example filter (V2 format): |
| 241 | # |
| 242 | # logName=projects/my-projectid/logs/syslog AND severity>=ERROR |
| 243 | "destination": "A String", # Required. The export destination. See |
| 244 | # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). |
| 245 | # Examples: |
| 246 | # |
| 247 | # "storage.googleapis.com/my-gcs-bucket" |
| 248 | # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" |
| 249 | # "pubsub.googleapis.com/projects/my-project/topics/my-topic" |
| 250 | "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write |
| 251 | # access. This may be a service account or a group. |
| 252 | # Examples (Do not assume these specific values): |
| 253 | # "serviceAccount:cloud-logs@system.gserviceaccount.com" |
| 254 | # "group:cloud-logs@google.com" |
| 255 | # |
| 256 | # For GCS destinations, the role "roles/owner" is required on the bucket |
| 257 | # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is |
| 258 | # required on the topic |
| 259 | # For BigQuery, the role "roles/editor" is required on the dataset |
| 260 | "name": "A String", # Required. The client-assigned sink identifier, unique within the |
| 261 | # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are |
| 262 | # limited to 1000 characters and can include only the following characters: |
| 263 | # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length |
| 264 | # of the name is 100 characters. |
| 265 | "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log |
| 266 | # entries. This version does not have to correspond to the version of the |
| 267 | # log entry that was written to Stackdriver Logging. If omitted, the |
| 268 | # v2 format is used. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 269 | }</pre> |
| 270 | </div> |
| 271 | |
| 272 | <div class="method"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 273 | <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code> |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 274 | <pre>Lists sinks. |
| 275 | |
| 276 | Args: |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 277 | parent: string, Required. The cloud resource containing the sinks. |
| 278 | Example: `"projects/my-logging-project"`. (required) |
| 279 | pageToken: string, Optional. If present, then retrieve the next batch of results from the |
| 280 | preceding call to this method. `pageToken` must be the value of |
| 281 | `nextPageToken` from the previous response. The values of other method |
| 282 | parameters should be identical to those in the previous call. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 283 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 284 | Allowed values |
| 285 | 1 - v1 error format |
| 286 | 2 - v2 error format |
| 287 | pageSize: integer, Optional. The maximum number of results to return from this request. |
| 288 | Non-positive values are ignored. The presence of `nextPageToken` in the |
| 289 | response indicates that more results might be available. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 290 | |
| 291 | Returns: |
| 292 | An object of the form: |
| 293 | |
| 294 | { # Result returned from `ListSinks`. |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 295 | "nextPageToken": "A String", # If there might be more results than appear in this response, then |
| 296 | # `nextPageToken` is included. To get the next set of results, call the same |
| 297 | # method again using the value of `nextPageToken` as `pageToken`. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 298 | "sinks": [ # A list of sinks. |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 299 | { # Describes a sink used to export log entries outside Stackdriver Logging. |
| 300 | "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). |
| 301 | # Only log entries matching the filter are exported. The filter |
| 302 | # must be consistent with the log entry format specified by the |
| 303 | # `outputVersionFormat` parameter, regardless of the format of the |
| 304 | # log entry that was originally written to Stackdriver Logging. |
| 305 | # Example filter (V2 format): |
| 306 | # |
| 307 | # logName=projects/my-projectid/logs/syslog AND severity>=ERROR |
| 308 | "destination": "A String", # Required. The export destination. See |
| 309 | # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). |
| 310 | # Examples: |
| 311 | # |
| 312 | # "storage.googleapis.com/my-gcs-bucket" |
| 313 | # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" |
| 314 | # "pubsub.googleapis.com/projects/my-project/topics/my-topic" |
| 315 | "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write |
| 316 | # access. This may be a service account or a group. |
| 317 | # Examples (Do not assume these specific values): |
| 318 | # "serviceAccount:cloud-logs@system.gserviceaccount.com" |
| 319 | # "group:cloud-logs@google.com" |
| 320 | # |
| 321 | # For GCS destinations, the role "roles/owner" is required on the bucket |
| 322 | # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is |
| 323 | # required on the topic |
| 324 | # For BigQuery, the role "roles/editor" is required on the dataset |
| 325 | "name": "A String", # Required. The client-assigned sink identifier, unique within the |
| 326 | # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are |
| 327 | # limited to 1000 characters and can include only the following characters: |
| 328 | # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length |
| 329 | # of the name is 100 characters. |
| 330 | "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log |
| 331 | # entries. This version does not have to correspond to the version of the |
| 332 | # log entry that was written to Stackdriver Logging. If omitted, the |
| 333 | # v2 format is used. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 334 | }, |
| 335 | ], |
| 336 | }</pre> |
| 337 | </div> |
| 338 | |
| 339 | <div class="method"> |
| 340 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 341 | <pre>Retrieves the next page of results. |
| 342 | |
| 343 | Args: |
| 344 | previous_request: The request for the previous page. (required) |
| 345 | previous_response: The response from the request for the previous page. (required) |
| 346 | |
| 347 | Returns: |
| 348 | A request object that you can call 'execute()' on to request the next |
| 349 | page. Returns None if there are no more items in the collection. |
| 350 | </pre> |
| 351 | </div> |
| 352 | |
| 353 | <div class="method"> |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 354 | <code class="details" id="update">update(sinkName=None, body, x__xgafv=None)</code> |
| 355 | <pre>Updates or creates a sink. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 356 | |
| 357 | Args: |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 358 | sinkName: string, Required. The resource name of the sink to update, including the parent |
| 359 | resource and the sink identifier. If the sink does not exist, this method |
| 360 | creates the sink. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required) |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 361 | body: object, The request body. (required) |
| 362 | The object takes the form of: |
| 363 | |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 364 | { # Describes a sink used to export log entries outside Stackdriver Logging. |
| 365 | "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). |
| 366 | # Only log entries matching the filter are exported. The filter |
| 367 | # must be consistent with the log entry format specified by the |
| 368 | # `outputVersionFormat` parameter, regardless of the format of the |
| 369 | # log entry that was originally written to Stackdriver Logging. |
| 370 | # Example filter (V2 format): |
| 371 | # |
| 372 | # logName=projects/my-projectid/logs/syslog AND severity>=ERROR |
| 373 | "destination": "A String", # Required. The export destination. See |
| 374 | # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). |
| 375 | # Examples: |
| 376 | # |
| 377 | # "storage.googleapis.com/my-gcs-bucket" |
| 378 | # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" |
| 379 | # "pubsub.googleapis.com/projects/my-project/topics/my-topic" |
| 380 | "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write |
| 381 | # access. This may be a service account or a group. |
| 382 | # Examples (Do not assume these specific values): |
| 383 | # "serviceAccount:cloud-logs@system.gserviceaccount.com" |
| 384 | # "group:cloud-logs@google.com" |
| 385 | # |
| 386 | # For GCS destinations, the role "roles/owner" is required on the bucket |
| 387 | # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is |
| 388 | # required on the topic |
| 389 | # For BigQuery, the role "roles/editor" is required on the dataset |
| 390 | "name": "A String", # Required. The client-assigned sink identifier, unique within the |
| 391 | # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are |
| 392 | # limited to 1000 characters and can include only the following characters: |
| 393 | # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length |
| 394 | # of the name is 100 characters. |
| 395 | "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log |
| 396 | # entries. This version does not have to correspond to the version of the |
| 397 | # log entry that was written to Stackdriver Logging. If omitted, the |
| 398 | # v2 format is used. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 399 | } |
| 400 | |
| 401 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 402 | Allowed values |
| 403 | 1 - v1 error format |
| 404 | 2 - v2 error format |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 405 | |
| 406 | Returns: |
| 407 | An object of the form: |
| 408 | |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame^] | 409 | { # Describes a sink used to export log entries outside Stackdriver Logging. |
| 410 | "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). |
| 411 | # Only log entries matching the filter are exported. The filter |
| 412 | # must be consistent with the log entry format specified by the |
| 413 | # `outputVersionFormat` parameter, regardless of the format of the |
| 414 | # log entry that was originally written to Stackdriver Logging. |
| 415 | # Example filter (V2 format): |
| 416 | # |
| 417 | # logName=projects/my-projectid/logs/syslog AND severity>=ERROR |
| 418 | "destination": "A String", # Required. The export destination. See |
| 419 | # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). |
| 420 | # Examples: |
| 421 | # |
| 422 | # "storage.googleapis.com/my-gcs-bucket" |
| 423 | # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset" |
| 424 | # "pubsub.googleapis.com/projects/my-project/topics/my-topic" |
| 425 | "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write |
| 426 | # access. This may be a service account or a group. |
| 427 | # Examples (Do not assume these specific values): |
| 428 | # "serviceAccount:cloud-logs@system.gserviceaccount.com" |
| 429 | # "group:cloud-logs@google.com" |
| 430 | # |
| 431 | # For GCS destinations, the role "roles/owner" is required on the bucket |
| 432 | # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is |
| 433 | # required on the topic |
| 434 | # For BigQuery, the role "roles/editor" is required on the dataset |
| 435 | "name": "A String", # Required. The client-assigned sink identifier, unique within the |
| 436 | # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are |
| 437 | # limited to 1000 characters and can include only the following characters: |
| 438 | # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length |
| 439 | # of the name is 100 characters. |
| 440 | "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log |
| 441 | # entries. This version does not have to correspond to the version of the |
| 442 | # log entry that was written to Stackdriver Logging. If omitted, the |
| 443 | # v2 format is used. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 444 | }</pre> |
| 445 | </div> |
| 446 | |
| 447 | </body></html> |