Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / remotebuildexecution_v2.v2.html
blob: 7cfd2ad9a1a5bc9a48001e10e0f7e3cace8686fc [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
84remote endpoint.
85Only the capabilities of the services supported by the endpoint will
86be 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
92Args:
93 instanceName: string, The instance of the execution system to operate against. A server may
94support multiple instances of the execution system (with their own workers,
95storage, caches, etc.). The server MAY require use of this field to select
96between them in an implementation-defined fashion, otherwise it can be
97omitted. (required)
98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
102
103Returns:
104 An object of the form:
105
106 { # A response message for
107 # Capabilities.GetCapabilities.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;cacheCapabilities&quot;: { # Capabilities of the remote cache system. # Capabilities of the remote cache system.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]109 &quot;symlinkAbsolutePathStrategy&quot;: &quot;A String&quot;, # Whether absolute symlink targets are supported.
110 &quot;actionCacheUpdateCapabilities&quot;: { # Describes the server/instance capabilities for updating the action cache. # Capabilities for updating the action cache.
111 &quot;updateEnabled&quot;: True or False,
112 },
113 &quot;digestFunction&quot;: [ # All the digest functions supported by the remote cache.
114 # Remote cache may support multiple digest functions simultaneously.
115 &quot;A String&quot;,
116 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117 &quot;maxBatchTotalSizeBytes&quot;: &quot;A String&quot;, # Maximum total size of blobs to be uploaded/downloaded using
118 # batch methods. A value of 0 means no limit is set, although
119 # in practice there will always be a message size limitation
120 # of the protocol in use, e.g. GRPC.
121 &quot;cachePriorityCapabilities&quot;: { # Allowed values for priority in # Supported cache priority range for both CAS and ActionCache.
122 # ResultsCachePolicy
123 # Used for querying both cache and execution valid priority ranges.
124 &quot;priorities&quot;: [
125 { # Supported range of priorities, including boundaries.
126 &quot;minPriority&quot;: 42,
127 &quot;maxPriority&quot;: 42,
128 },
129 ],
130 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]132 &quot;lowApiVersion&quot;: { # The full version of a given tool. # Earliest non-deprecated RE API version supported.
133 &quot;minor&quot;: 42, # The minor version, e.g. 2 for 10.2.3.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]134 &quot;patch&quot;: 42, # The patch version, e.g 3 for 10.2.3.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]135 &quot;major&quot;: 42, # The major version, e.g 10 for 10.2.3.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 &quot;prerelease&quot;: &quot;A String&quot;, # The pre-release version. Either this field or major/minor/patch fields
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]137 # must be filled. They are mutually exclusive. Pre-release versions are
138 # assumed to be earlier than any released versions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 },
140 &quot;deprecatedApiVersion&quot;: { # The full version of a given tool. # Earliest RE API version supported, including deprecated versions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;minor&quot;: 42, # The minor version, e.g. 2 for 10.2.3.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 &quot;patch&quot;: 42, # The patch version, e.g 3 for 10.2.3.
143 &quot;major&quot;: 42, # The major version, e.g 10 for 10.2.3.
144 &quot;prerelease&quot;: &quot;A String&quot;, # The pre-release version. Either this field or major/minor/patch fields
145 # must be filled. They are mutually exclusive. Pre-release versions are
146 # assumed to be earlier than any released versions.
147 },
148 &quot;highApiVersion&quot;: { # The full version of a given tool. # Latest RE API version supported.
149 &quot;minor&quot;: 42, # The minor version, e.g. 2 for 10.2.3.
150 &quot;patch&quot;: 42, # The patch version, e.g 3 for 10.2.3.
151 &quot;major&quot;: 42, # The major version, e.g 10 for 10.2.3.
152 &quot;prerelease&quot;: &quot;A String&quot;, # The pre-release version. Either this field or major/minor/patch fields
153 # must be filled. They are mutually exclusive. Pre-release versions are
154 # assumed to be earlier than any released versions.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]155 },
156 &quot;executionCapabilities&quot;: { # Capabilities of the remote execution system. # Capabilities of the remote execution system.
157 &quot;execEnabled&quot;: True or False, # Whether remote execution is enabled for the particular server/instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]158 &quot;supportedNodeProperties&quot;: [ # Supported node properties.
159 &quot;A String&quot;,
160 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]161 &quot;digestFunction&quot;: &quot;A String&quot;, # Remote execution may only support a single digest function.
162 &quot;executionPriorityCapabilities&quot;: { # Allowed values for priority in # Supported execution priority range.
163 # ResultsCachePolicy
164 # Used for querying both cache and execution valid priority ranges.
165 &quot;priorities&quot;: [
166 { # Supported range of priorities, including boundaries.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]167 &quot;minPriority&quot;: 42,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]168 &quot;maxPriority&quot;: 42,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]169 },
170 ],
171 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 }</pre>
174</div>
175
176</body></html>