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

blob: e05c83809199785e482146009a5836c9a75c0b8b [file] [log] [blame]

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.billingAccounts.html">billingAccounts</a> . <a href="logging_v2.billingAccounts.locations.html">locations</a> . <a href="logging_v2.billingAccounts.locations.buckets.html">buckets</a> . <a href="logging_v2.billingAccounts.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">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	87	<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]	88	<p class="firstline">Lists views on a log bucket.</p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	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">
				93	<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]	94	<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]	95	<h3>Method Details</h3>
				96	<div class="method">
				97	<code class="details" id="close">close()</code>
				98	<pre>Close httplib2 connections.</pre>
				99	</div>
				100
				101	<div class="method">
				102	<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]	103	<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]	104
				105	Args:
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	106	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]	107	body: object, The request body.
				108	The object takes the form of:
				109
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	110	{ # Describes a view over log entries in a bucket.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	111	"createTime": "A String", # Output only. The creation timestamp of the view.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	112	"description": "A String", # Describes this view.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	113	"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")
				114	"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]	115	"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]	116	}
				117
				118	viewId: string, Required. The id to use for this view.
				119	x__xgafv: string, V1 error format.
				120	Allowed values
				121	1 - v1 error format
				122	2 - v2 error format
				123
				124	Returns:
				125	An object of the form:
				126
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	127	{ # Describes a view over log entries in a bucket.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	128	"createTime": "A String", # Output only. The creation timestamp of the view.
				129	"description": "A String", # Describes this view.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	130	"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")
				131	"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]	132	"updateTime": "A String", # Output only. The last update timestamp of the view.
				133	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	134	</div>
				135
				136	<div class="method">
				137	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	138	<pre>Deletes a view on a log bucket.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	139
				140	Args:
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	141	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]	142	x__xgafv: string, V1 error format.
				143	Allowed values
				144	1 - v1 error format
				145	2 - v2 error format
				146
				147	Returns:
				148	An object of the form:
				149
				150	{ # 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]	151	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	152	</div>
				153
				154	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	155	<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]	156	<pre>Lists views on a log bucket.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	157
				158	Args:
				159	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]	160	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]	161	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]	162	x__xgafv: string, V1 error format.
				163	Allowed values
				164	1 - v1 error format
				165	2 - v2 error format
				166
				167	Returns:
				168	An object of the form:
				169
				170	{ # The response from ListViews.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	171	"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.
				172	"views": [ # A list of views.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	173	{ # Describes a view over log entries in a bucket.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	174	"createTime": "A String", # Output only. The creation timestamp of the view.
				175	"description": "A String", # Describes this view.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	176	"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")
				177	"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]	178	"updateTime": "A String", # Output only. The last update timestamp of the view.
				179	},
				180	],
				181	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	182	</div>
				183
				184	<div class="method">
				185	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				186	<pre>Retrieves the next page of results.
				187
				188	Args:
				189	previous_request: The request for the previous page. (required)
				190	previous_response: The response from the request for the previous page. (required)
				191
				192	Returns:
				193	A request object that you can call 'execute()' on to request the next
				194	page. Returns None if there are no more items in the collection.
				195	</pre>
				196	</div>
				197
				198	<div class="method">
				199	<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]	200	<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]	201
				202	Args:
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	203	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]	204	body: object, The request body.
				205	The object takes the form of:
				206
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	207	{ # Describes a view over log entries in a bucket.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	208	"createTime": "A String", # Output only. The creation timestamp of the view.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	209	"description": "A String", # Describes this view.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	210	"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")
				211	"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]	212	"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]	213	}
				214
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	215	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]	216	x__xgafv: string, V1 error format.
				217	Allowed values
				218	1 - v1 error format
				219	2 - v2 error format
				220
				221	Returns:
				222	An object of the form:
				223
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	224	{ # Describes a view over log entries in a bucket.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	225	"createTime": "A String", # Output only. The creation timestamp of the view.
				226	"description": "A String", # Describes this view.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	227	"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")
				228	"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]	229	"updateTime": "A String", # Output only. The last update timestamp of the view.
				230	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	231	</div>
				232
				233	</body></html>