Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [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 | |
| 75 | <h1><a href="logging_v2.html">Cloud Logging API</a> . <a href="logging_v2.locations.html">locations</a> . <a href="logging_v2.locations.buckets.html">buckets</a> . <a href="logging_v2.locations.buckets.views.html">views</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#create">create(parent, body=None, viewId=None, x__xgafv=None)</a></code></p> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 82 | <p class="firstline">Creates a view over log entries in a log bucket. A bucket may contain a maximum of 50 views.</p> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 85 | <p class="firstline">Deletes a view on a log bucket.</p> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 88 | <p class="firstline">Gets a view on a log bucket..</p> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 91 | <p class="firstline">Lists views on a log bucket.</p> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 97 | <p class="firstline">Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter.</p> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| 105 | <code class="details" id="create">create(parent, body=None, viewId=None, x__xgafv=None)</code> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 106 | <pre>Creates a view over log entries in a log bucket. A bucket may contain a maximum of 50 views. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 107 | |
| 108 | Args: |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 109 | parent: string, Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" (required) |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 113 | { # Describes a view over log entries in a bucket. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 114 | "createTime": "A String", # Output only. The creation timestamp of the view. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 115 | "description": "A String", # Describes this view. |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 116 | "filter": "A String", # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout") |
| 117 | "name": "A String", # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 118 | "updateTime": "A String", # Output only. The last update timestamp of the view. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | viewId: string, Required. The id to use for this view. |
| 122 | x__xgafv: string, V1 error format. |
| 123 | Allowed values |
| 124 | 1 - v1 error format |
| 125 | 2 - v2 error format |
| 126 | |
| 127 | Returns: |
| 128 | An object of the form: |
| 129 | |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 130 | { # Describes a view over log entries in a bucket. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 131 | "createTime": "A String", # Output only. The creation timestamp of the view. |
| 132 | "description": "A String", # Describes this view. |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 133 | "filter": "A String", # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout") |
| 134 | "name": "A String", # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 135 | "updateTime": "A String", # Output only. The last update timestamp of the view. |
| 136 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 137 | </div> |
| 138 | |
| 139 | <div class="method"> |
| 140 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 141 | <pre>Deletes a view on a log bucket. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 142 | |
| 143 | Args: |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 144 | name: string, Required. The full resource name of the view to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" (required) |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 145 | x__xgafv: string, V1 error format. |
| 146 | Allowed values |
| 147 | 1 - v1 error format |
| 148 | 2 - v2 error format |
| 149 | |
| 150 | Returns: |
| 151 | An object of the form: |
| 152 | |
| 153 | { # 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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 154 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 155 | </div> |
| 156 | |
| 157 | <div class="method"> |
| 158 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 159 | <pre>Gets a view on a log bucket.. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 160 | |
| 161 | Args: |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 162 | name: string, Required. The resource name of the policy: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" (required) |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 163 | x__xgafv: string, V1 error format. |
| 164 | Allowed values |
| 165 | 1 - v1 error format |
| 166 | 2 - v2 error format |
| 167 | |
| 168 | Returns: |
| 169 | An object of the form: |
| 170 | |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 171 | { # Describes a view over log entries in a bucket. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 172 | "createTime": "A String", # Output only. The creation timestamp of the view. |
| 173 | "description": "A String", # Describes this view. |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 174 | "filter": "A String", # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout") |
| 175 | "name": "A String", # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 176 | "updateTime": "A String", # Output only. The last update timestamp of the view. |
| 177 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 178 | </div> |
| 179 | |
| 180 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 181 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 182 | <pre>Lists views on a log bucket. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 183 | |
| 184 | Args: |
| 185 | parent: string, Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" (required) |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 186 | 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. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 187 | 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. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 188 | x__xgafv: string, V1 error format. |
| 189 | Allowed values |
| 190 | 1 - v1 error format |
| 191 | 2 - v2 error format |
| 192 | |
| 193 | Returns: |
| 194 | An object of the form: |
| 195 | |
| 196 | { # The response from ListViews. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 197 | "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. |
| 198 | "views": [ # A list of views. |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 199 | { # Describes a view over log entries in a bucket. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 200 | "createTime": "A String", # Output only. The creation timestamp of the view. |
| 201 | "description": "A String", # Describes this view. |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 202 | "filter": "A String", # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout") |
| 203 | "name": "A String", # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 204 | "updateTime": "A String", # Output only. The last update timestamp of the view. |
| 205 | }, |
| 206 | ], |
| 207 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 208 | </div> |
| 209 | |
| 210 | <div class="method"> |
| 211 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 212 | <pre>Retrieves the next page of results. |
| 213 | |
| 214 | Args: |
| 215 | previous_request: The request for the previous page. (required) |
| 216 | previous_response: The response from the request for the previous page. (required) |
| 217 | |
| 218 | Returns: |
| 219 | A request object that you can call 'execute()' on to request the next |
| 220 | page. Returns None if there are no more items in the collection. |
| 221 | </pre> |
| 222 | </div> |
| 223 | |
| 224 | <div class="method"> |
| 225 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 226 | <pre>Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 227 | |
| 228 | Args: |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 229 | name: string, Required. The full resource name of the view to update "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" (required) |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 230 | body: object, The request body. |
| 231 | The object takes the form of: |
| 232 | |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 233 | { # Describes a view over log entries in a bucket. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 234 | "createTime": "A String", # Output only. The creation timestamp of the view. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 235 | "description": "A String", # Describes this view. |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 236 | "filter": "A String", # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout") |
| 237 | "name": "A String", # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 238 | "updateTime": "A String", # Output only. The last update timestamp of the view. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 239 | } |
| 240 | |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 241 | updateMask: string, Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 242 | x__xgafv: string, V1 error format. |
| 243 | Allowed values |
| 244 | 1 - v1 error format |
| 245 | 2 - v2 error format |
| 246 | |
| 247 | Returns: |
| 248 | An object of the form: |
| 249 | |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 250 | { # Describes a view over log entries in a bucket. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 251 | "createTime": "A String", # Output only. The creation timestamp of the view. |
| 252 | "description": "A String", # Describes this view. |
yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame^] | 253 | "filter": "A String", # Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout") |
| 254 | "name": "A String", # The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 255 | "updateTime": "A String", # Output only. The last update timestamp of the view. |
| 256 | }</pre> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 257 | </div> |
| 258 | |
| 259 | </body></html> |