Blame - docs/dyn/cloudbuild_v1alpha2.projects.locations.operations.html - platform/external/python/google-api-python-client

blob: 5095db5e847640c6fd785090f957ce3025871539 [file] [log] [blame]

Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -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="cloudbuild_v1alpha2.html">Cloud Build API</a> . <a href="cloudbuild_v1alpha2.projects.html">projects</a> . <a href="cloudbuild_v1alpha2.projects.locations.html">locations</a> . <a href="cloudbuild_v1alpha2.projects.locations.operations.html">operations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#cancel">cancel(name, body=None, 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="#get">get(name, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	83	<h3>Method Details</h3>
				84	<div class="method">
				85	<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
				86	<pre>Starts asynchronous cancellation on a long-running operation. The server
				87	makes a best effort to cancel the operation, but success is not
				88	guaranteed. If the server doesn't support this method, it returns
				89	`google.rpc.Code.UNIMPLEMENTED`. Clients can use
				90	Operations.GetOperation or
				91	other methods to check whether the cancellation succeeded or whether the
				92	operation completed despite cancellation. On successful cancellation,
				93	the operation is not deleted; instead, it becomes an operation with
				94	an Operation.error value with a google.rpc.Status.code of 1,
				95	corresponding to `Code.CANCELLED`.
				96
				97	Args:
				98	name: string, The name of the operation resource to be cancelled. (required)
				99	body: object, The request body.
				100	The object takes the form of:
				101
				102	{ # The request message for Operations.CancelOperation.
				103	}
				104
				105	x__xgafv: string, V1 error format.
				106	Allowed values
				107	1 - v1 error format
				108	2 - v2 error format
				109
				110	Returns:
				111	An object of the form:
				112
				113	{ # A generic empty message that you can re-use to avoid defining duplicated
				114	# empty messages in your APIs. A typical example is to use it as the request
				115	# or the response type of an API method. For instance:
				116	#
				117	# service Foo {
				118	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				119	# }
				120	#
				121	# The JSON representation for `Empty` is empty JSON object `{}`.
				122	}</pre>
				123	</div>
				124
				125	<div class="method">
				126	<code class="details" id="get">get(name, x__xgafv=None)</code>
				127	<pre>Gets the latest state of a long-running operation. Clients can use this
				128	method to poll the operation result at intervals as recommended by the API
				129	service.
				130
				131	Args:
				132	name: string, The name of the operation resource. (required)
				133	x__xgafv: string, V1 error format.
				134	Allowed values
				135	1 - v1 error format
				136	2 - v2 error format
				137
				138	Returns:
				139	An object of the form:
				140
				141	{ # This resource represents a long-running operation that is the result of a
				142	# network API call.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	143	"name": "A String", # The server-assigned name, which is only unique within the same service that
				144	# originally returns it. If you use the default HTTP mapping, the
				145	# `name` should be a resource name ending with `operations/{unique_id}`.
				146	"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.
				147	# different programming environments, including REST APIs and RPC APIs. It is
				148	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				149	# three pieces of data: error code, error message, and error details.
				150	#
				151	# You can find out more about this error model and how to work with it in the
				152	# [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	153	"message": "A String", # A developer-facing error message, which should be in English. Any
				154	# user-facing error message should be localized and sent in the
				155	# google.rpc.Status.details field, or localized by the client.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	156	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	157	"details": [ # A list of messages that carry the error details. There is a common set of
				158	# message types for APIs to use.
				159	{
				160	"a_key": "", # Properties of the object. Contains field @type with type URL.
				161	},
				162	],
				163	},
				164	"metadata": { # Service-specific metadata associated with the operation. It typically
				165	# contains progress information and common metadata such as create time.
				166	# Some services might not provide such metadata. Any method that returns a
				167	# long-running operation should document the metadata type, if any.
				168	"a_key": "", # Properties of the object. Contains field @type with type URL.
				169	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	170	"response": { # The normal response of the operation in case of success. If the original
				171	# method returns no data on success, such as `Delete`, the response is
				172	# `google.protobuf.Empty`. If the original method is standard
				173	# `Get`/`Create`/`Update`, the response should be the resource. For other
				174	# methods, the response should have the type `XxxResponse`, where `Xxx`
				175	# is the original method name. For example, if the original method name
				176	# is `TakeSnapshot()`, the inferred response type is
				177	# `TakeSnapshotResponse`.
				178	"a_key": "", # Properties of the object. Contains field @type with type URL.
				179	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	180	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				181	# If `true`, the operation is completed, and either `error` or `response` is
				182	# available.
				183	}</pre>
				184	</div>
				185
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	186	</body></html>