Blame - docs/dyn/remotebuildexecution_v2.v2.html - platform/external/python/google-api-python-client

blob: bbe6d270ecb54cb83a1997d0c09754274f919e6d [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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="remotebuildexecution_v2.html">Remote Build Execution API</a> . <a href="remotebuildexecution_v2.v2.html">v2</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#getCapabilities">getCapabilities(instanceName, x__xgafv=None)</a></code></p>
				79	<p class="firstline">GetCapabilities returns the server capabilities configuration of the</p>
				80	<h3>Method Details</h3>
				81	<div class="method">
				82	<code class="details" id="getCapabilities">getCapabilities(instanceName, x__xgafv=None)</code>
				83	<pre>GetCapabilities returns the server capabilities configuration of the
				84	remote endpoint.
				85	Only the capabilities of the services supported by the endpoint will
				86	be returned:
				87	* Execution + CAS + Action Cache endpoints should return both
				88	CacheCapabilities and ExecutionCapabilities.
				89	* Execution only endpoints should return ExecutionCapabilities.
				90	* CAS + Action Cache only endpoints should return CacheCapabilities.
				91
				92	Args:
				93	instanceName: string, The instance of the execution system to operate against. A server may
				94	support multiple instances of the execution system (with their own workers,
				95	storage, caches, etc.). The server MAY require use of this field to select
				96	between them in an implementation-defined fashion, otherwise it can be
				97	omitted. (required)
				98	x__xgafv: string, V1 error format.
				99	Allowed values
				100	1 - v1 error format
				101	2 - v2 error format
				102
				103	Returns:
				104	An object of the form:
				105
				106	{ # A response message for
				107	# Capabilities.GetCapabilities.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	108	"executionCapabilities": { # Capabilities of the remote execution system. # Capabilities of the remote execution system.
				109	"digestFunction": "A String", # Remote execution may only support a single digest function.
				110	"executionPriorityCapabilities": { # Allowed values for priority in # Supported execution priority range.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	# ResultsCachePolicy
				112	# Used for querying both cache and execution valid priority ranges.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	113	"priorities": [
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	114	{ # Supported range of priorities, including boundaries.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	115	"maxPriority": 42,
				116	"minPriority": 42,
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	},
				118	],
				119	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	120	"supportedNodeProperties": [ # Supported node properties.
				121	"A String",
				122	],
				123	"execEnabled": True or False, # Whether remote execution is enabled for the particular server/instance.
				124	},
				125	"deprecatedApiVersion": { # The full version of a given tool. # Earliest RE API version supported, including deprecated versions.
				126	"prerelease": "A String", # The pre-release version. Either this field or major/minor/patch fields
				127	# must be filled. They are mutually exclusive. Pre-release versions are
				128	# assumed to be earlier than any released versions.
				129	"major": 42, # The major version, e.g 10 for 10.2.3.
				130	"minor": 42, # The minor version, e.g. 2 for 10.2.3.
				131	"patch": 42, # The patch version, e.g 3 for 10.2.3.
				132	},
				133	"lowApiVersion": { # The full version of a given tool. # Earliest non-deprecated RE API version supported.
				134	"prerelease": "A String", # The pre-release version. Either this field or major/minor/patch fields
				135	# must be filled. They are mutually exclusive. Pre-release versions are
				136	# assumed to be earlier than any released versions.
				137	"major": 42, # The major version, e.g 10 for 10.2.3.
				138	"minor": 42, # The minor version, e.g. 2 for 10.2.3.
				139	"patch": 42, # The patch version, e.g 3 for 10.2.3.
				140	},
				141	"cacheCapabilities": { # Capabilities of the remote cache system. # Capabilities of the remote cache system.
				142	"symlinkAbsolutePathStrategy": "A String", # Whether absolute symlink targets are supported.
				143	"actionCacheUpdateCapabilities": { # Describes the server/instance capabilities for updating the action cache. # Capabilities for updating the action cache.
				144	"updateEnabled": True or False,
				145	},
				146	"digestFunction": [ # All the digest functions supported by the remote cache.
				147	# Remote cache may support multiple digest functions simultaneously.
				148	"A String",
				149	],
				150	"cachePriorityCapabilities": { # Allowed values for priority in # Supported cache priority range for both CAS and ActionCache.
				151	# ResultsCachePolicy
				152	# Used for querying both cache and execution valid priority ranges.
				153	"priorities": [
				154	{ # Supported range of priorities, including boundaries.
				155	"maxPriority": 42,
				156	"minPriority": 42,
				157	},
				158	],
				159	},
				160	"maxBatchTotalSizeBytes": "A String", # Maximum total size of blobs to be uploaded/downloaded using
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	161	# batch methods. A value of 0 means no limit is set, although
				162	# in practice there will always be a message size limitation
				163	# of the protocol in use, e.g. GRPC.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	164	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	165	"highApiVersion": { # The full version of a given tool. # Latest RE API version supported.
				166	"prerelease": "A String", # The pre-release version. Either this field or major/minor/patch fields
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	167	# must be filled. They are mutually exclusive. Pre-release versions are
				168	# assumed to be earlier than any released versions.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	169	"major": 42, # The major version, e.g 10 for 10.2.3.
				170	"minor": 42, # The minor version, e.g. 2 for 10.2.3.
				171	"patch": 42, # The patch version, e.g 3 for 10.2.3.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	173	}</pre>
				174	</div>
				175
				176	</body></html>