Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7700bbffda386345cc4426ef413fc643f6368ef4 / . / docs / dyn / remotebuildexecution_v2.v2.html
blob: aae5666d15e6eb3da64f9fe0417da90851839a6c [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]81 <code><a href="#getCapabilities">getCapabilities(instanceName, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">GetCapabilities returns the server capabilities configuration of the remote endpoint. Only the capabilities of the services supported by the endpoint will be returned: * Execution + CAS + Action Cache endpoints should return both CacheCapabilities and ExecutionCapabilities. * Execution only endpoints should return ExecutionCapabilities. * CAS + Action Cache only endpoints should return CacheCapabilities.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 <code class="details" id="getCapabilities">getCapabilities(instanceName, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <pre>GetCapabilities returns the server capabilities configuration of the remote endpoint. Only the capabilities of the services supported by the endpoint will be returned: * Execution + CAS + Action Cache endpoints should return both CacheCapabilities and ExecutionCapabilities. * Execution only endpoints should return ExecutionCapabilities. * CAS + Action Cache only endpoints should return CacheCapabilities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92
93Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 instanceName: string, The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99
100Returns:
101 An object of the form:
102
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 { # A response message for Capabilities.GetCapabilities.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]104 &quot;cacheCapabilities&quot;: { # Capabilities of the remote cache system. # Capabilities of the remote cache system.
105 &quot;actionCacheUpdateCapabilities&quot;: { # Describes the server/instance capabilities for updating the action cache. # Capabilities for updating the action cache.
106 &quot;updateEnabled&quot;: True or False,
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]107 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]108 &quot;cachePriorityCapabilities&quot;: { # Allowed values for priority in ResultsCachePolicy and ExecutionPolicy Used for querying both cache and execution valid priority ranges. # Supported cache priority range for both CAS and ActionCache.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]109 &quot;priorities&quot;: [
110 { # Supported range of priorities, including boundaries.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]111 &quot;maxPriority&quot;: 42, # The maximum numeric value for this priority range, which represents the least urgent task or shortest retained item.
112 &quot;minPriority&quot;: 42, # The minimum numeric value for this priority range, which represents the most urgent task or longest retained item.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]113 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]114 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]115 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]116 &quot;digestFunction&quot;: [ # All the digest functions supported by the remote cache. Remote cache may support multiple digest functions simultaneously.
117 &quot;A String&quot;,
118 ],
119 &quot;maxBatchTotalSizeBytes&quot;: &quot;A String&quot;, # Maximum total size of blobs to be uploaded/downloaded using batch methods. A value of 0 means no limit is set, although in practice there will always be a message size limitation of the protocol in use, e.g. GRPC.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]120 &quot;supportedCompressor&quot;: [ # Compressors supported by the &quot;compressed-blobs&quot; bytestream resources. Servers MUST support identity/no-compression, even if it is not listed here. Note that this does not imply which if any compressors are supported by the server at the gRPC level.
121 &quot;A String&quot;,
122 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]123 &quot;symlinkAbsolutePathStrategy&quot;: &quot;A String&quot;, # Whether absolute symlink targets are supported.
124 },
125 &quot;deprecatedApiVersion&quot;: { # The full version of a given tool. # Earliest RE API version supported, including deprecated versions.
126 &quot;major&quot;: 42, # The major version, e.g 10 for 10.2.3.
127 &quot;minor&quot;: 42, # The minor version, e.g. 2 for 10.2.3.
128 &quot;patch&quot;: 42, # The patch version, e.g 3 for 10.2.3.
129 &quot;prerelease&quot;: &quot;A String&quot;, # The pre-release version. Either this field or major/minor/patch fields must be filled. They are mutually exclusive. Pre-release versions are assumed to be earlier than any released versions.
130 },
131 &quot;executionCapabilities&quot;: { # Capabilities of the remote execution system. # Capabilities of the remote execution system.
132 &quot;digestFunction&quot;: &quot;A String&quot;, # Remote execution may only support a single digest function.
133 &quot;execEnabled&quot;: True or False, # Whether remote execution is enabled for the particular server/instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]134 &quot;executionPriorityCapabilities&quot;: { # Allowed values for priority in ResultsCachePolicy and ExecutionPolicy Used for querying both cache and execution valid priority ranges. # Supported execution priority range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]135 &quot;priorities&quot;: [
136 { # Supported range of priorities, including boundaries.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]137 &quot;maxPriority&quot;: 42, # The maximum numeric value for this priority range, which represents the least urgent task or shortest retained item.
138 &quot;minPriority&quot;: 42, # The minimum numeric value for this priority range, which represents the most urgent task or longest retained item.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]139 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]140 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]141 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]142 &quot;supportedNodeProperties&quot;: [ # Supported node properties.
143 &quot;A String&quot;,
144 ],
145 },
146 &quot;highApiVersion&quot;: { # The full version of a given tool. # Latest RE API version supported.
147 &quot;major&quot;: 42, # The major version, e.g 10 for 10.2.3.
148 &quot;minor&quot;: 42, # The minor version, e.g. 2 for 10.2.3.
149 &quot;patch&quot;: 42, # The patch version, e.g 3 for 10.2.3.
150 &quot;prerelease&quot;: &quot;A String&quot;, # The pre-release version. Either this field or major/minor/patch fields must be filled. They are mutually exclusive. Pre-release versions are assumed to be earlier than any released versions.
151 },
152 &quot;lowApiVersion&quot;: { # The full version of a given tool. # Earliest non-deprecated RE API version supported.
153 &quot;major&quot;: 42, # The major version, e.g 10 for 10.2.3.
154 &quot;minor&quot;: 42, # The minor version, e.g. 2 for 10.2.3.
155 &quot;patch&quot;: 42, # The patch version, e.g 3 for 10.2.3.
156 &quot;prerelease&quot;: &quot;A String&quot;, # The pre-release version. Either this field or major/minor/patch fields must be filled. They are mutually exclusive. Pre-release versions are assumed to be earlier than any released versions.
157 },
158}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159</div>
160
161</body></html>