Blame - docs/dyn/logging_v2.projects.locations.buckets.html - platform/external/python/google-api-python-client

blob: 673904fab99eb141a6e6c9037028ac3536d84730 [file] [log] [blame]

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">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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, bucketId=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a bucket. Moves the bucket to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all logs in the bucket will be permanently deleted.</p>
				86	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets a bucket (Beta).</p>
				89	<p class="toc_element">
				90	<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Lists buckets (Beta).</p>
				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>
				97	<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>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	98	<p class="toc_element">
				99	<code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
				100	<p class="firstline">Undeletes a bucket. A bucket that has been deleted may be undeleted within the grace period of 7 days.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	101	<h3>Method Details</h3>
				102	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<code class="details" id="close">close()</code>
				104	<pre>Close httplib2 connections.</pre>
				105	</div>
				106
				107	<div class="method">
				108	<code class="details" id="create">create(parent, body=None, bucketId=None, x__xgafv=None)</code>
				109	<pre>Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	110
				111	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	112	parent: string, Required. The resource in which to create the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" Example: "projects/my-logging-project/locations/global" (required)
				113	body: object, The request body.
				114	The object takes the form of:
				115
				116	{ # Describes a repository of logs (Beta).
				117	"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.
				118	"locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
				119	"description": "A String", # Describes this bucket.
				120	"lifecycleState": "A String", # Output only. The bucket lifecycle state.
				121	"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"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.
				122	"createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
				123	"updateTime": "A String", # Output only. The last update timestamp of the bucket.
				124	}
				125
				126	bucketId: string, Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	127	x__xgafv: string, V1 error format.
				128	Allowed values
				129	1 - v1 error format
				130	2 - v2 error format
				131
				132	Returns:
				133	An object of the form:
				134
				135	{ # Describes a repository of logs (Beta).
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	136	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	137	"locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	138	"description": "A String", # Describes this bucket.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	139	"lifecycleState": "A String", # Output only. The bucket lifecycle state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	140	"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"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.
				141	"createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
				142	"updateTime": "A String", # Output only. The last update timestamp of the bucket.
				143	}</pre>
				144	</div>
				145
				146	<div class="method">
				147	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				148	<pre>Deletes a bucket. Moves the bucket to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all logs in the bucket will be permanently deleted.
				149
				150	Args:
				151	name: string, Required. The full resource name of the bucket to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". (required)
				152	x__xgafv: string, V1 error format.
				153	Allowed values
				154	1 - v1 error format
				155	2 - v2 error format
				156
				157	Returns:
				158	An object of the form:
				159
				160	{ # 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 {}.
				161	}</pre>
				162	</div>
				163
				164	<div class="method">
				165	<code class="details" id="get">get(name, x__xgafv=None)</code>
				166	<pre>Gets a bucket (Beta).
				167
				168	Args:
				169	name: string, Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". (required)
				170	x__xgafv: string, V1 error format.
				171	Allowed values
				172	1 - v1 error format
				173	2 - v2 error format
				174
				175	Returns:
				176	An object of the form:
				177
				178	{ # Describes a repository of logs (Beta).
				179	"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.
				180	"locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
				181	"description": "A String", # Describes this bucket.
				182	"lifecycleState": "A String", # Output only. The bucket lifecycle state.
				183	"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"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.
				184	"createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
				185	"updateTime": "A String", # Output only. The last update timestamp of the bucket.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	186	}</pre>
				187	</div>
				188
				189	<div class="method">
				190	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
				191	<pre>Lists buckets (Beta).
				192
				193	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	194	parent: string, Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	195	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.
				196	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.
				197	x__xgafv: string, V1 error format.
				198	Allowed values
				199	1 - v1 error format
				200	2 - v2 error format
				201
				202	Returns:
				203	An object of the form:
				204
				205	{ # The response from ListBuckets (Beta).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	206	"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]	207	"buckets": [ # A list of buckets.
				208	{ # Describes a repository of logs (Beta).
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	209	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	210	"locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	211	"description": "A String", # Describes this bucket.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	212	"lifecycleState": "A String", # Output only. The bucket lifecycle state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	213	"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"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.
				214	"createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
				215	"updateTime": "A String", # Output only. The last update timestamp of the bucket.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	216	},
				217	],
				218	}</pre>
				219	</div>
				220
				221	<div class="method">
				222	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				223	<pre>Retrieves the next page of results.
				224
				225	Args:
				226	previous_request: The request for the previous page. (required)
				227	previous_response: The response from the request for the previous page. (required)
				228
				229	Returns:
				230	A request object that you can call 'execute()' on to request the next
				231	page. Returns None if there are no more items in the collection.
				232	</pre>
				233	</div>
				234
				235	<div class="method">
				236	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				237	<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.
				238
				239	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	240	name: string, Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	241	body: object, The request body.
				242	The object takes the form of:
				243
				244	{ # Describes a repository of logs (Beta).
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	245	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	246	"locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	247	"description": "A String", # Describes this bucket.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	248	"lifecycleState": "A String", # Output only. The bucket lifecycle state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	249	"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"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.
				250	"createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
				251	"updateTime": "A String", # Output only. The last update timestamp of the bucket.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	252	}
				253
				254	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.
				255	x__xgafv: string, V1 error format.
				256	Allowed values
				257	1 - v1 error format
				258	2 - v2 error format
				259
				260	Returns:
				261	An object of the form:
				262
				263	{ # Describes a repository of logs (Beta).
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	264	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	265	"locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	266	"description": "A String", # Describes this bucket.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	267	"lifecycleState": "A String", # Output only. The bucket lifecycle state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	268	"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"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.
				269	"createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
				270	"updateTime": "A String", # Output only. The last update timestamp of the bucket.
				271	}</pre>
				272	</div>
				273
				274	<div class="method">
				275	<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
				276	<pre>Undeletes a bucket. A bucket that has been deleted may be undeleted within the grace period of 7 days.
				277
				278	Args:
				279	name: string, Required. The full resource name of the bucket to undelete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". (required)
				280	body: object, The request body.
				281	The object takes the form of:
				282
				283	{ # The parameters to UndeleteBucket.
				284	}
				285
				286	x__xgafv: string, V1 error format.
				287	Allowed values
				288	1 - v1 error format
				289	2 - v2 error format
				290
				291	Returns:
				292	An object of the form:
				293
				294	{ # 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 {}.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	295	}</pre>
				296	</div>
				297
				298	</body></html>