| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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.projects.html">projects</a> . <a href="logging_v2.projects.locations.html">locations</a> . <a href="logging_v2.projects.locations.buckets.html">buckets</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Gets a bucket (Beta).</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Lists buckets (Beta).</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 92 | <pre>Gets a bucket (Beta). |
| 93 | |
| 94 | Args: |
| 95 | name: string, Required. The resource name of the bucket: |
| 96 | "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" |
| 97 | "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" |
| 98 | "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" |
| 99 | "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" |
| 100 | Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". (required) |
| 101 | x__xgafv: string, V1 error format. |
| 102 | Allowed values |
| 103 | 1 - v1 error format |
| 104 | 2 - v2 error format |
| 105 | |
| 106 | Returns: |
| 107 | An object of the form: |
| 108 | |
| 109 | { # Describes a repository of logs (Beta). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | "updateTime": "A String", # Output only. The last update timestamp of the bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 111 | "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 112 | "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. |
| 113 | "name": "A String", # The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id The supported locations are: "global" "us-central1"For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. |
| 114 | "description": "A String", # Describes this bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 115 | "lifecycleState": "A String", # Output only. The bucket lifecycle state. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | }</pre> |
| 117 | </div> |
| 118 | |
| 119 | <div class="method"> |
| 120 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 121 | <pre>Lists buckets (Beta). |
| 122 | |
| 123 | Args: |
| 124 | parent: string, Required. The parent resource whose buckets are to be listed: |
| 125 | "projects/[PROJECT_ID]/locations/[LOCATION_ID]" |
| 126 | "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" |
| 127 | "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" |
| 128 | "folders/[FOLDER_ID]/locations/[LOCATION_ID]" |
| 129 | Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. (required) |
| 130 | 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. |
| 131 | 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. |
| 132 | x__xgafv: string, V1 error format. |
| 133 | Allowed values |
| 134 | 1 - v1 error format |
| 135 | 2 - v2 error format |
| 136 | |
| 137 | Returns: |
| 138 | An object of the form: |
| 139 | |
| 140 | { # The response from ListBuckets (Beta). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | "buckets": [ # A list of buckets. |
| 142 | { # Describes a repository of logs (Beta). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 143 | "updateTime": "A String", # Output only. The last update timestamp of the bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 144 | "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 145 | "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. |
| 146 | "name": "A String", # The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id The supported locations are: "global" "us-central1"For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. |
| 147 | "description": "A String", # Describes this bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 148 | "lifecycleState": "A String", # Output only. The bucket lifecycle state. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 149 | }, |
| 150 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 151 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | }</pre> |
| 153 | </div> |
| 154 | |
| 155 | <div class="method"> |
| 156 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 157 | <pre>Retrieves the next page of results. |
| 158 | |
| 159 | Args: |
| 160 | previous_request: The request for the previous page. (required) |
| 161 | previous_response: The response from the request for the previous page. (required) |
| 162 | |
| 163 | Returns: |
| 164 | A request object that you can call 'execute()' on to request the next |
| 165 | page. Returns None if there are no more items in the collection. |
| 166 | </pre> |
| 167 | </div> |
| 168 | |
| 169 | <div class="method"> |
| 170 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 171 | <pre>Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta. |
| 172 | |
| 173 | Args: |
| 174 | name: string, Required. The full resource name of the bucket to update. |
| 175 | "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" |
| 176 | "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" |
| 177 | "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" |
| 178 | "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" |
| 179 | Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property (required) |
| 180 | body: object, The request body. |
| 181 | The object takes the form of: |
| 182 | |
| 183 | { # Describes a repository of logs (Beta). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 184 | "updateTime": "A String", # Output only. The last update timestamp of the bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 185 | "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 186 | "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. |
| 187 | "name": "A String", # The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id The supported locations are: "global" "us-central1"For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. |
| 188 | "description": "A String", # Describes this bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 189 | "lifecycleState": "A String", # Output only. The bucket lifecycle state. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 190 | } |
| 191 | |
| 192 | updateMask: string, Required. Field mask that specifies the fields in bucket that need an update. A bucket 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.FieldMaskExample: updateMask=retention_days. |
| 193 | x__xgafv: string, V1 error format. |
| 194 | Allowed values |
| 195 | 1 - v1 error format |
| 196 | 2 - v2 error format |
| 197 | |
| 198 | Returns: |
| 199 | An object of the form: |
| 200 | |
| 201 | { # Describes a repository of logs (Beta). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 202 | "updateTime": "A String", # Output only. The last update timestamp of the bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 203 | "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 204 | "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. |
| 205 | "name": "A String", # The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id The supported locations are: "global" "us-central1"For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. |
| 206 | "description": "A String", # Describes this bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 207 | "lifecycleState": "A String", # Output only. The bucket lifecycle state. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | }</pre> |
| 209 | </div> |
| 210 | |
| 211 | </body></html> |