Blame - docs/dyn/spanner_v1.projects.instances.backups.operations.html - platform/external/python/google-api-python-client

blob: ad02eae8db8e9727a7bb307b24ef5693b66447f8 [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="spanner_v1.html">Cloud Spanner API</a> . <a href="spanner_v1.projects.html">projects</a> . <a href="spanner_v1.projects.instances.html">instances</a> . <a href="spanner_v1.projects.instances.backups.html">backups</a> . <a href="spanner_v1.projects.instances.backups.operations.html">operations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
				86	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	87	<code><a href="#list">list(name, 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]	88	<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
				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	<h3>Method Details</h3>
				93	<div class="method">
				94	<code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
				95	<pre>Starts asynchronous cancellation on a long-running operation. The server
				96	makes a best effort to cancel the operation, but success is not
				97	guaranteed. If the server doesn't support this method, it returns
				98	`google.rpc.Code.UNIMPLEMENTED`. Clients can use
				99	Operations.GetOperation or
				100	other methods to check whether the cancellation succeeded or whether the
				101	operation completed despite cancellation. On successful cancellation,
				102	the operation is not deleted; instead, it becomes an operation with
				103	an Operation.error value with a google.rpc.Status.code of 1,
				104	corresponding to `Code.CANCELLED`.
				105
				106	Args:
				107	name: string, The name of the operation resource to be cancelled. (required)
				108	x__xgafv: string, V1 error format.
				109	Allowed values
				110	1 - v1 error format
				111	2 - v2 error format
				112
				113	Returns:
				114	An object of the form:
				115
				116	{ # A generic empty message that you can re-use to avoid defining duplicated
				117	# empty messages in your APIs. A typical example is to use it as the request
				118	# or the response type of an API method. For instance:
				119	#
				120	# service Foo {
				121	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				122	# }
				123	#
				124	# The JSON representation for `Empty` is empty JSON object `{}`.
				125	}</pre>
				126	</div>
				127
				128	<div class="method">
				129	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				130	<pre>Deletes a long-running operation. This method indicates that the client is
				131	no longer interested in the operation result. It does not cancel the
				132	operation. If the server doesn't support this method, it returns
				133	`google.rpc.Code.UNIMPLEMENTED`.
				134
				135	Args:
				136	name: string, The name of the operation resource to be deleted. (required)
				137	x__xgafv: string, V1 error format.
				138	Allowed values
				139	1 - v1 error format
				140	2 - v2 error format
				141
				142	Returns:
				143	An object of the form:
				144
				145	{ # A generic empty message that you can re-use to avoid defining duplicated
				146	# empty messages in your APIs. A typical example is to use it as the request
				147	# or the response type of an API method. For instance:
				148	#
				149	# service Foo {
				150	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				151	# }
				152	#
				153	# The JSON representation for `Empty` is empty JSON object `{}`.
				154	}</pre>
				155	</div>
				156
				157	<div class="method">
				158	<code class="details" id="get">get(name, x__xgafv=None)</code>
				159	<pre>Gets the latest state of a long-running operation. Clients can use this
				160	method to poll the operation result at intervals as recommended by the API
				161	service.
				162
				163	Args:
				164	name: string, The name of the operation resource. (required)
				165	x__xgafv: string, V1 error format.
				166	Allowed values
				167	1 - v1 error format
				168	2 - v2 error format
				169
				170	Returns:
				171	An object of the form:
				172
				173	{ # This resource represents a long-running operation that is the result of a
				174	# network API call.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	175	"name": "A String", # The server-assigned name, which is only unique within the same service that
				176	# originally returns it. If you use the default HTTP mapping, the
				177	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	178	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				179	# different programming environments, including REST APIs and RPC APIs. It is
				180	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				181	# three pieces of data: error code, error message, and error details.
				182	#
				183	# You can find out more about this error model and how to work with it in the
				184	# [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	185	"message": "A String", # A developer-facing error message, which should be in English. Any
				186	# user-facing error message should be localized and sent in the
				187	# google.rpc.Status.details field, or localized by the client.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	188	"details": [ # A list of messages that carry the error details. There is a common set of
				189	# message types for APIs to use.
				190	{
				191	"a_key": "", # Properties of the object. Contains field @type with type URL.
				192	},
				193	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	194	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				195	},
				196	"metadata": { # Service-specific metadata associated with the operation. It typically
				197	# contains progress information and common metadata such as create time.
				198	# Some services might not provide such metadata. Any method that returns a
				199	# long-running operation should document the metadata type, if any.
				200	"a_key": "", # Properties of the object. Contains field @type with type URL.
				201	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	202	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				203	# If `true`, the operation is completed, and either `error` or `response` is
				204	# available.
				205	"response": { # The normal response of the operation in case of success. If the original
				206	# method returns no data on success, such as `Delete`, the response is
				207	# `google.protobuf.Empty`. If the original method is standard
				208	# `Get`/`Create`/`Update`, the response should be the resource. For other
				209	# methods, the response should have the type `XxxResponse`, where `Xxx`
				210	# is the original method name. For example, if the original method name
				211	# is `TakeSnapshot()`, the inferred response type is
				212	# `TakeSnapshotResponse`.
				213	"a_key": "", # Properties of the object. Contains field @type with type URL.
				214	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	215	}</pre>
				216	</div>
				217
				218	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	219	<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	220	<pre>Lists operations that match the specified filter in the request. If the
				221	server doesn't support this method, it returns `UNIMPLEMENTED`.
				222
				223	NOTE: the `name` binding allows API services to override the binding
				224	to use different resource name schemes, such as `users/*/operations`. To
				225	override the binding, API services can add a binding such as
				226	`"/v1/{name=users/*}/operations"` to their service configuration.
				227	For backwards compatibility, the default name includes the operations
				228	collection id, however overriding users must ensure the name binding
				229	is the parent resource, without the operations collection id.
				230
				231	Args:
				232	name: string, The name of the operation's parent resource. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	233	filter: string, The standard list filter.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	234	pageSize: integer, The standard list page size.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	235	pageToken: string, The standard list page token.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	236	x__xgafv: string, V1 error format.
				237	Allowed values
				238	1 - v1 error format
				239	2 - v2 error format
				240
				241	Returns:
				242	An object of the form:
				243
				244	{ # The response message for Operations.ListOperations.
				245	"nextPageToken": "A String", # The standard List next-page token.
				246	"operations": [ # A list of operations that matches the specified filter in the request.
				247	{ # This resource represents a long-running operation that is the result of a
				248	# network API call.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	249	"name": "A String", # The server-assigned name, which is only unique within the same service that
				250	# originally returns it. If you use the default HTTP mapping, the
				251	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	252	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				253	# different programming environments, including REST APIs and RPC APIs. It is
				254	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				255	# three pieces of data: error code, error message, and error details.
				256	#
				257	# You can find out more about this error model and how to work with it in the
				258	# [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	259	"message": "A String", # A developer-facing error message, which should be in English. Any
				260	# user-facing error message should be localized and sent in the
				261	# google.rpc.Status.details field, or localized by the client.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	262	"details": [ # A list of messages that carry the error details. There is a common set of
				263	# message types for APIs to use.
				264	{
				265	"a_key": "", # Properties of the object. Contains field @type with type URL.
				266	},
				267	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	268	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				269	},
				270	"metadata": { # Service-specific metadata associated with the operation. It typically
				271	# contains progress information and common metadata such as create time.
				272	# Some services might not provide such metadata. Any method that returns a
				273	# long-running operation should document the metadata type, if any.
				274	"a_key": "", # Properties of the object. Contains field @type with type URL.
				275	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	276	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				277	# If `true`, the operation is completed, and either `error` or `response` is
				278	# available.
				279	"response": { # The normal response of the operation in case of success. If the original
				280	# method returns no data on success, such as `Delete`, the response is
				281	# `google.protobuf.Empty`. If the original method is standard
				282	# `Get`/`Create`/`Update`, the response should be the resource. For other
				283	# methods, the response should have the type `XxxResponse`, where `Xxx`
				284	# is the original method name. For example, if the original method name
				285	# is `TakeSnapshot()`, the inferred response type is
				286	# `TakeSnapshotResponse`.
				287	"a_key": "", # Properties of the object. Contains field @type with type URL.
				288	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	289	},
				290	],
				291	}</pre>
				292	</div>
				293
				294	<div class="method">
				295	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				296	<pre>Retrieves the next page of results.
				297
				298	Args:
				299	previous_request: The request for the previous page. (required)
				300	previous_response: The response from the request for the previous page. (required)
				301
				302	Returns:
				303	A request object that you can call 'execute()' on to request the next
				304	page. Returns None if there are no more items in the collection.
				305	</pre>
				306	</div>
				307
				308	</body></html>