Blame - docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.html - platform/external/python/google-api-python-client

blob: 642805ea44ad30056fdc761ba38f65d004560caa [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="bigqueryreservation_v1beta1.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1beta1.projects.html">projects</a> . <a href="bigqueryreservation_v1beta1.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1beta1.projects.locations.reservations.html">reservations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html">assignments()</a></code>
				79	</p>
				80	<p class="firstline">Returns the assignments Resource.</p>
				81
				82	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	86	<code><a href="#create">create(parent, body=None, reservationId=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Creates a new reservation resource.</p>
				88	<p class="toc_element">
				89	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	90	<p class="firstline">Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	91	<p class="toc_element">
				92	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				93	<p class="firstline">Returns information about the reservation.</p>
				94	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	95	<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	96	<p class="firstline">Lists all the reservations for the project in the specified location.</p>
				97	<p class="toc_element">
				98	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				99	<p class="firstline">Retrieves the next page of results.</p>
				100	<p class="toc_element">
				101	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				102	<p class="firstline">Updates an existing reservation resource.</p>
				103	<h3>Method Details</h3>
				104	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	105	<code class="details" id="close">close()</code>
				106	<pre>Close httplib2 connections.</pre>
				107	</div>
				108
				109	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	110	<code class="details" id="create">create(parent, body=None, reservationId=None, x__xgafv=None)</code>
				111	<pre>Creates a new reservation resource.
				112
				113	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	parent: string, Required. Project, location. E.g., `projects/myproject/locations/US` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	115	body: object, The request body.
				116	The object takes the form of:
				117
				118	{ # A reservation is a mechanism used to guarantee slots to users.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	119	"creationTime": "A String", # Output only. Creation time of the reservation.
				120	"ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
				121	"name": "A String", # The resource name of the reservation, e.g., `projects//locations//reservations/team1-prod`.
				122	"slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
				123	"updateTime": "A String", # Output only. Last update time of the reservation.
				124	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	125
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	126	reservationId: string, The reservation ID. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters.
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	{ # A reservation is a mechanism used to guarantee slots to users.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	136	"creationTime": "A String", # Output only. Creation time of the reservation.
				137	"ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
				138	"name": "A String", # The resource name of the reservation, e.g., `projects//locations//reservations/team1-prod`.
				139	"slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
				140	"updateTime": "A String", # Output only. Last update time of the reservation.
				141	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	142	</div>
				143
				144	<div class="method">
				145	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	146	<pre>Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	147
				148	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	149	name: string, Required. Resource name of the reservation to retrieve. E.g., `projects/myproject/locations/US/reservations/team1-prod` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	150	x__xgafv: string, V1 error format.
				151	Allowed values
				152	1 - v1 error format
				153	2 - v2 error format
				154
				155	Returns:
				156	An object of the form:
				157
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	158	{ # 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]	159	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	</div>
				161
				162	<div class="method">
				163	<code class="details" id="get">get(name, x__xgafv=None)</code>
				164	<pre>Returns information about the reservation.
				165
				166	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	167	name: string, Required. Resource name of the reservation to retrieve. E.g., `projects/myproject/locations/US/reservations/team1-prod` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	168	x__xgafv: string, V1 error format.
				169	Allowed values
				170	1 - v1 error format
				171	2 - v2 error format
				172
				173	Returns:
				174	An object of the form:
				175
				176	{ # A reservation is a mechanism used to guarantee slots to users.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	177	"creationTime": "A String", # Output only. Creation time of the reservation.
				178	"ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
				179	"name": "A String", # The resource name of the reservation, e.g., `projects//locations//reservations/team1-prod`.
				180	"slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
				181	"updateTime": "A String", # Output only. Last update time of the reservation.
				182	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	183	</div>
				184
				185	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	186	<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	187	<pre>Lists all the reservations for the project in the specified location.
				188
				189	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	190	parent: string, Required. The parent resource name containing project and location, e.g.: `projects/myproject/locations/US` (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	191	filter: string, Can be used to filter out reservations based on names, capacity, etc, e.g.: filter="reservation.slot_capacity > 200" filter="reservation.name = \"dev/\"" Advanced filtering syntax can be [here](https://cloud.google.com/logging/docs/view/advanced-filters).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	192	pageSize: integer, The maximum number of items to return.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	193	pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	194	x__xgafv: string, V1 error format.
				195	Allowed values
				196	1 - v1 error format
				197	2 - v2 error format
				198
				199	Returns:
				200	An object of the form:
				201
				202	{ # The response for ReservationService.ListReservations.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	203	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				204	"reservations": [ # List of reservations visible to the user.
				205	{ # A reservation is a mechanism used to guarantee slots to users.
				206	"creationTime": "A String", # Output only. Creation time of the reservation.
				207	"ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
				208	"name": "A String", # The resource name of the reservation, e.g., `projects//locations//reservations/team1-prod`.
				209	"slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
				210	"updateTime": "A String", # Output only. Last update time of the reservation.
				211	},
				212	],
				213	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	214	</div>
				215
				216	<div class="method">
				217	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				218	<pre>Retrieves the next page of results.
				219
				220	Args:
				221	previous_request: The request for the previous page. (required)
				222	previous_response: The response from the request for the previous page. (required)
				223
				224	Returns:
				225	A request object that you can call 'execute()' on to request the next
				226	page. Returns None if there are no more items in the collection.
				227	</pre>
				228	</div>
				229
				230	<div class="method">
				231	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				232	<pre>Updates an existing reservation resource.
				233
				234	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	235	name: string, The resource name of the reservation, e.g., `projects//locations//reservations/team1-prod`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	236	body: object, The request body.
				237	The object takes the form of:
				238
				239	{ # A reservation is a mechanism used to guarantee slots to users.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	240	"creationTime": "A String", # Output only. Creation time of the reservation.
				241	"ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
				242	"name": "A String", # The resource name of the reservation, e.g., `projects//locations//reservations/team1-prod`.
				243	"slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
				244	"updateTime": "A String", # Output only. Last update time of the reservation.
				245	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	246
				247	updateMask: string, Standard field mask for the set of fields to be updated.
				248	x__xgafv: string, V1 error format.
				249	Allowed values
				250	1 - v1 error format
				251	2 - v2 error format
				252
				253	Returns:
				254	An object of the form:
				255
				256	{ # A reservation is a mechanism used to guarantee slots to users.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	257	"creationTime": "A String", # Output only. Creation time of the reservation.
				258	"ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
				259	"name": "A String", # The resource name of the reservation, e.g., `projects//locations//reservations/team1-prod`.
				260	"slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
				261	"updateTime": "A String", # Output only. Last update time of the reservation.
				262	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	263	</div>
				264
				265	</body></html>