Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 32d1c597b364e2641eca33ccf6df802bb218eea1 / . / docs / dyn / discovery_v1.apis.html
blob: d0f6b1b2ef9fc6c7f43e16fa2c3029218c56ea81 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="discovery_v1.html">API Discovery Service</a> . <a href="discovery_v1.apis.html">apis</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]81 <code><a href="#getRest">getRest(api, version)</a></code></p>
82<p class="firstline">Retrieve the description of a particular version of an api.</p>
83<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]84 <code><a href="#list">list(preferred=None, name=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Retrieve the list of APIs supported at this endpoint.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93 <code class="details" id="getRest">getRest(api, version)</code>
94 <pre>Retrieve the description of a particular version of an api.
95
96Args:
97 api: string, The name of the API. (required)
98 version: string, The version of the API. (required)
99
100Returns:
101 An object of the form:
102
103 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]104 &quot;packagePath&quot;: &quot;A String&quot;, # The package of the owner of this API. See ownerDomain.
105 &quot;name&quot;: &quot;A String&quot;, # The name of this API.
106 &quot;labels&quot;: [ # Labels for the status of this API, such as labs or deprecated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]107 &quot;A String&quot;,
108 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]109 &quot;exponentialBackoffDefault&quot;: True or False, # Enable exponential backoff for suitable methods in the generated clients.
110 &quot;discoveryVersion&quot;: &quot;v1&quot;, # Indicate the version of the Discovery API used to generate this doc.
111 &quot;kind&quot;: &quot;discovery#restDescription&quot;, # The kind for this response.
112 &quot;basePath&quot;: &quot;A String&quot;, # [DEPRECATED] The base path for REST requests.
113 &quot;version&quot;: &quot;A String&quot;, # The version of this API.
114 &quot;ownerDomain&quot;: &quot;A String&quot;, # The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name.
115 &quot;baseUrl&quot;: &quot;A String&quot;, # [DEPRECATED] The base URL for REST requests.
116 &quot;version_module&quot;: True or False,
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]117 &quot;icons&quot;: { # Links to 16x16 and 32x32 icons representing the API.
118 &quot;x32&quot;: &quot;A String&quot;, # The URL of the 32x32 icon.
119 &quot;x16&quot;: &quot;A String&quot;, # The URL of the 16x16 icon.
120 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]121 &quot;revision&quot;: &quot;A String&quot;, # The version of this API.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]122 &quot;servicePath&quot;: &quot;A String&quot;, # The base path for all REST requests.
123 &quot;rootUrl&quot;: &quot;A String&quot;, # The root URL under which all API services live.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]124 &quot;etag&quot;: &quot;A String&quot;, # The ETag for this response.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]125 &quot;id&quot;: &quot;A String&quot;, # The ID of this API.
126 &quot;methods&quot;: { # API-level methods for this API.
127 &quot;a_key&quot;: { # An individual method description.
128 &quot;parameterOrder&quot;: [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the &quot;most-significant&quot; parameter appears first.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]129 &quot;A String&quot;,
130 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]131 &quot;scopes&quot;: [ # OAuth 2.0 scopes applicable to this method.
132 &quot;A String&quot;,
133 ],
134 &quot;response&quot;: { # The schema for the response.
135 &quot;$ref&quot;: &quot;A String&quot;, # Schema ID for the response schema.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]136 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]137 &quot;path&quot;: &quot;A String&quot;, # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
138 &quot;mediaUpload&quot;: { # Media upload parameters.
139 &quot;maxSize&quot;: &quot;A String&quot;, # Maximum size of a media upload, such as &quot;1MB&quot;, &quot;2GB&quot; or &quot;3TB&quot;.
140 &quot;protocols&quot;: { # Supported upload protocols.
141 &quot;resumable&quot;: { # Supports the Resumable Media Upload protocol.
142 &quot;path&quot;: &quot;A String&quot;, # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
143 &quot;multipart&quot;: true, # True if this endpoint supports uploading multipart media.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]144 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]145 &quot;simple&quot;: { # Supports uploading as a single HTTP request.
146 &quot;path&quot;: &quot;A String&quot;, # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
147 &quot;multipart&quot;: true, # True if this endpoint supports upload multipart media.
148 },
149 },
150 &quot;accept&quot;: [ # MIME Media Ranges for acceptable media uploads to this method.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]151 &quot;A String&quot;,
152 ],
153 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]154 &quot;request&quot;: { # The schema for the request.
155 &quot;parameterName&quot;: &quot;A String&quot;, # parameter name.
156 &quot;$ref&quot;: &quot;A String&quot;, # Schema ID for the request schema.
157 },
158 &quot;id&quot;: &quot;A String&quot;, # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
159 &quot;supportsSubscription&quot;: True or False, # Whether this method supports subscriptions.
160 &quot;parameters&quot;: { # Details for all parameters in this method.
161 &quot;a_key&quot;: { # Details for a single parameter in this method.
162 &quot;minimum&quot;: &quot;A String&quot;, # The minimum value of this parameter.
163 &quot;type&quot;: &quot;A String&quot;, # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
164 &quot;location&quot;: &quot;A String&quot;, # Whether this parameter goes in the query or the path for REST requests.
165 &quot;default&quot;: &quot;A String&quot;, # The default value of this property (if one exists).
166 &quot;items&quot;: # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
167 &quot;enum&quot;: [ # Values this parameter may take (if it is an enum).
168 &quot;A String&quot;,
169 ],
170 &quot;maximum&quot;: &quot;A String&quot;, # The maximum value of this parameter.
171 &quot;enumDescriptions&quot;: [ # The descriptions for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
172 &quot;A String&quot;,
173 ],
174 &quot;$ref&quot;: &quot;A String&quot;, # A reference to another schema. The value of this property is the &quot;id&quot; of another schema.
175 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for this schema.
176 &quot;required&quot;: True or False, # Whether the parameter is required.
177 &quot;additionalProperties&quot;: # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
178 &quot;readOnly&quot;: True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
179 &quot;repeated&quot;: True or False, # Whether this parameter may appear multiple times.
180 &quot;description&quot;: &quot;A String&quot;, # A description of this object.
181 &quot;pattern&quot;: &quot;A String&quot;, # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
182 &quot;annotations&quot;: { # Additional information about this property.
183 &quot;required&quot;: [ # A list of methods for which this property is required on requests.
184 &quot;A String&quot;,
185 ],
186 },
187 &quot;properties&quot;: { # If this is a schema for an object, list the schema for each property of this object.
188 &quot;a_key&quot;: # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
189 },
190 &quot;format&quot;: &quot;A String&quot;, # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
191 &quot;variant&quot;: { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
192 &quot;discriminant&quot;: &quot;A String&quot;, # The name of the type discriminant property.
193 &quot;map&quot;: [ # The map of discriminant value to schema to use for parsing..
194 {
195 &quot;$ref&quot;: &quot;A String&quot;,
196 &quot;type_value&quot;: &quot;A String&quot;,
197 },
198 ],
199 },
200 },
201 },
202 &quot;etagRequired&quot;: True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
203 &quot;useMediaDownloadService&quot;: True or False, # Indicates that downloads from this method should use the download service URL (i.e. &quot;/download&quot;). Only applies if the method supports media download.
204 &quot;httpMethod&quot;: &quot;A String&quot;, # HTTP method used by this method.
205 &quot;supportsMediaDownload&quot;: True or False, # Whether this method supports media downloads.
206 &quot;supportsMediaUpload&quot;: True or False, # Whether this method supports media uploads.
207 &quot;description&quot;: &quot;A String&quot;, # Description of this method.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]208 },
209 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]210 &quot;auth&quot;: { # Authentication information.
211 &quot;oauth2&quot;: { # OAuth 2.0 authentication information.
212 &quot;scopes&quot;: { # Available OAuth 2.0 scopes.
213 &quot;a_key&quot;: { # The scope value.
214 &quot;description&quot;: &quot;A String&quot;, # Description of scope.
215 },
216 },
217 },
218 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]219 &quot;protocol&quot;: &quot;rest&quot;, # The protocol described by this document.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]220 &quot;ownerName&quot;: &quot;A String&quot;, # The name of the owner of this API. See ownerDomain.
221 &quot;description&quot;: &quot;A String&quot;, # The description of this API.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]222 &quot;schemas&quot;: { # The schemas for this API.
223 &quot;a_key&quot;: { # An individual schema description.
224 &quot;minimum&quot;: &quot;A String&quot;, # The minimum value of this parameter.
225 &quot;type&quot;: &quot;A String&quot;, # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]226 &quot;location&quot;: &quot;A String&quot;, # Whether this parameter goes in the query or the path for REST requests.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]227 &quot;default&quot;: &quot;A String&quot;, # The default value of this property (if one exists).
228 &quot;items&quot;: # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
229 &quot;enum&quot;: [ # Values this parameter may take (if it is an enum).
230 &quot;A String&quot;,
231 ],
232 &quot;maximum&quot;: &quot;A String&quot;, # The maximum value of this parameter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]233 &quot;enumDescriptions&quot;: [ # The descriptions for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]234 &quot;A String&quot;,
235 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]236 &quot;$ref&quot;: &quot;A String&quot;, # A reference to another schema. The value of this property is the &quot;id&quot; of another schema.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]237 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for this schema.
238 &quot;required&quot;: True or False, # Whether the parameter is required.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]239 &quot;additionalProperties&quot;: # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]240 &quot;readOnly&quot;: True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]241 &quot;repeated&quot;: True or False, # Whether this parameter may appear multiple times.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]242 &quot;description&quot;: &quot;A String&quot;, # A description of this object.
243 &quot;pattern&quot;: &quot;A String&quot;, # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]244 &quot;annotations&quot;: { # Additional information about this property.
245 &quot;required&quot;: [ # A list of methods for which this property is required on requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]246 &quot;A String&quot;,
247 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]248 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]249 &quot;properties&quot;: { # If this is a schema for an object, list the schema for each property of this object.
250 &quot;a_key&quot;: # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
251 },
252 &quot;format&quot;: &quot;A String&quot;, # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
253 &quot;variant&quot;: { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
254 &quot;discriminant&quot;: &quot;A String&quot;, # The name of the type discriminant property.
255 &quot;map&quot;: [ # The map of discriminant value to schema to use for parsing..
256 {
257 &quot;$ref&quot;: &quot;A String&quot;,
258 &quot;type_value&quot;: &quot;A String&quot;,
259 },
260 ],
261 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]262 },
263 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]264 &quot;title&quot;: &quot;A String&quot;, # The title of this API.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]265 &quot;resources&quot;: { # The resources in this API.
266 &quot;a_key&quot;: { # An individual resource description. Contains methods and sub-resources related to this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]267 &quot;methods&quot;: { # Methods on this resource.
268 &quot;a_key&quot;: { # Description for any methods on this resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]269 &quot;parameterOrder&quot;: [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the &quot;most-significant&quot; parameter appears first.
270 &quot;A String&quot;,
271 ],
272 &quot;scopes&quot;: [ # OAuth 2.0 scopes applicable to this method.
273 &quot;A String&quot;,
274 ],
275 &quot;response&quot;: { # The schema for the response.
276 &quot;$ref&quot;: &quot;A String&quot;, # Schema ID for the response schema.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]277 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]278 &quot;path&quot;: &quot;A String&quot;, # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
279 &quot;mediaUpload&quot;: { # Media upload parameters.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]280 &quot;maxSize&quot;: &quot;A String&quot;, # Maximum size of a media upload, such as &quot;1MB&quot;, &quot;2GB&quot; or &quot;3TB&quot;.
281 &quot;protocols&quot;: { # Supported upload protocols.
282 &quot;resumable&quot;: { # Supports the Resumable Media Upload protocol.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]283 &quot;path&quot;: &quot;A String&quot;, # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]284 &quot;multipart&quot;: true, # True if this endpoint supports uploading multipart media.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]285 },
286 &quot;simple&quot;: { # Supports uploading as a single HTTP request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]287 &quot;path&quot;: &quot;A String&quot;, # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]288 &quot;multipart&quot;: true, # True if this endpoint supports upload multipart media.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]289 },
290 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]291 &quot;accept&quot;: [ # MIME Media Ranges for acceptable media uploads to this method.
292 &quot;A String&quot;,
293 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]294 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]295 &quot;request&quot;: { # The schema for the request.
296 &quot;parameterName&quot;: &quot;A String&quot;, # parameter name.
297 &quot;$ref&quot;: &quot;A String&quot;, # Schema ID for the request schema.
298 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]299 &quot;id&quot;: &quot;A String&quot;, # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]300 &quot;supportsSubscription&quot;: True or False, # Whether this method supports subscriptions.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]301 &quot;parameters&quot;: { # Details for all parameters in this method.
302 &quot;a_key&quot;: { # Details for a single parameter in this method.
303 &quot;minimum&quot;: &quot;A String&quot;, # The minimum value of this parameter.
304 &quot;type&quot;: &quot;A String&quot;, # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
305 &quot;location&quot;: &quot;A String&quot;, # Whether this parameter goes in the query or the path for REST requests.
306 &quot;default&quot;: &quot;A String&quot;, # The default value of this property (if one exists).
307 &quot;items&quot;: # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
308 &quot;enum&quot;: [ # Values this parameter may take (if it is an enum).
309 &quot;A String&quot;,
310 ],
311 &quot;maximum&quot;: &quot;A String&quot;, # The maximum value of this parameter.
312 &quot;enumDescriptions&quot;: [ # The descriptions for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
313 &quot;A String&quot;,
314 ],
315 &quot;$ref&quot;: &quot;A String&quot;, # A reference to another schema. The value of this property is the &quot;id&quot; of another schema.
316 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for this schema.
317 &quot;required&quot;: True or False, # Whether the parameter is required.
318 &quot;additionalProperties&quot;: # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
319 &quot;readOnly&quot;: True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
320 &quot;repeated&quot;: True or False, # Whether this parameter may appear multiple times.
321 &quot;description&quot;: &quot;A String&quot;, # A description of this object.
322 &quot;pattern&quot;: &quot;A String&quot;, # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
323 &quot;annotations&quot;: { # Additional information about this property.
324 &quot;required&quot;: [ # A list of methods for which this property is required on requests.
325 &quot;A String&quot;,
326 ],
327 },
328 &quot;properties&quot;: { # If this is a schema for an object, list the schema for each property of this object.
329 &quot;a_key&quot;: # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
330 },
331 &quot;format&quot;: &quot;A String&quot;, # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
332 &quot;variant&quot;: { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
333 &quot;discriminant&quot;: &quot;A String&quot;, # The name of the type discriminant property.
334 &quot;map&quot;: [ # The map of discriminant value to schema to use for parsing..
335 {
336 &quot;$ref&quot;: &quot;A String&quot;,
337 &quot;type_value&quot;: &quot;A String&quot;,
338 },
339 ],
340 },
341 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]342 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]343 &quot;etagRequired&quot;: True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]344 &quot;useMediaDownloadService&quot;: True or False, # Indicates that downloads from this method should use the download service URL (i.e. &quot;/download&quot;). Only applies if the method supports media download.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]345 &quot;httpMethod&quot;: &quot;A String&quot;, # HTTP method used by this method.
346 &quot;supportsMediaDownload&quot;: True or False, # Whether this method supports media downloads.
347 &quot;supportsMediaUpload&quot;: True or False, # Whether this method supports media uploads.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]348 &quot;description&quot;: &quot;A String&quot;, # Description of this method.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]349 },
350 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]351 &quot;resources&quot;: { # Sub-resources on this resource.
352 &quot;a_key&quot;: # Object with schema name: RestResource # Description for any sub-resources on this resource.
353 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]354 },
355 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]356 &quot;canonicalName&quot;: &quot;A String&quot;, # Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.
357 &quot;parameters&quot;: { # Common parameters that apply across all apis.
358 &quot;a_key&quot;: { # Description of a single parameter.
359 &quot;minimum&quot;: &quot;A String&quot;, # The minimum value of this parameter.
360 &quot;type&quot;: &quot;A String&quot;, # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
361 &quot;location&quot;: &quot;A String&quot;, # Whether this parameter goes in the query or the path for REST requests.
362 &quot;default&quot;: &quot;A String&quot;, # The default value of this property (if one exists).
363 &quot;items&quot;: # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
364 &quot;enum&quot;: [ # Values this parameter may take (if it is an enum).
365 &quot;A String&quot;,
366 ],
367 &quot;maximum&quot;: &quot;A String&quot;, # The maximum value of this parameter.
368 &quot;enumDescriptions&quot;: [ # The descriptions for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
369 &quot;A String&quot;,
370 ],
371 &quot;$ref&quot;: &quot;A String&quot;, # A reference to another schema. The value of this property is the &quot;id&quot; of another schema.
372 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for this schema.
373 &quot;required&quot;: True or False, # Whether the parameter is required.
374 &quot;additionalProperties&quot;: # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
375 &quot;readOnly&quot;: True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
376 &quot;repeated&quot;: True or False, # Whether this parameter may appear multiple times.
377 &quot;description&quot;: &quot;A String&quot;, # A description of this object.
378 &quot;pattern&quot;: &quot;A String&quot;, # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
379 &quot;annotations&quot;: { # Additional information about this property.
380 &quot;required&quot;: [ # A list of methods for which this property is required on requests.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]381 &quot;A String&quot;,
382 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]383 },
384 &quot;properties&quot;: { # If this is a schema for an object, list the schema for each property of this object.
385 &quot;a_key&quot;: # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
386 },
387 &quot;format&quot;: &quot;A String&quot;, # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
388 &quot;variant&quot;: { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
389 &quot;discriminant&quot;: &quot;A String&quot;, # The name of the type discriminant property.
390 &quot;map&quot;: [ # The map of discriminant value to schema to use for parsing..
391 {
392 &quot;$ref&quot;: &quot;A String&quot;,
393 &quot;type_value&quot;: &quot;A String&quot;,
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]394 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]395 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]396 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]397 },
398 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]399 &quot;batchPath&quot;: &quot;A String&quot;, # The path for REST batch requests.
400 &quot;documentationLink&quot;: &quot;A String&quot;, # A link to human readable documentation for the API.
401 &quot;features&quot;: [ # A list of supported features for this API.
402 &quot;A String&quot;,
403 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]404 }</pre>
405</div>
406
407<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]408 <code class="details" id="list">list(preferred=None, name=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]409 <pre>Retrieve the list of APIs supported at this endpoint.
410
411Args:
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]412 preferred: boolean, Return only the preferred version of an API.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]413 name: string, Only include APIs with the given name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]414
415Returns:
416 An object of the form:
417
418 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]419 &quot;items&quot;: [ # The individual directory entries. One entry per api/version pair.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]420 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]421 &quot;kind&quot;: &quot;discovery#directoryItem&quot;, # The kind for this response.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]422 &quot;preferred&quot;: True or False, # True if this version is the preferred version to use.
423 &quot;discoveryLink&quot;: &quot;A String&quot;, # A link to the discovery document.
424 &quot;name&quot;: &quot;A String&quot;, # The name of the API.
425 &quot;labels&quot;: [ # Labels for the status of this API, such as labs or deprecated.
426 &quot;A String&quot;,
427 ],
428 &quot;description&quot;: &quot;A String&quot;, # The description of this API.
429 &quot;version&quot;: &quot;A String&quot;, # The version of the API.
430 &quot;title&quot;: &quot;A String&quot;, # The title of this API.
431 &quot;documentationLink&quot;: &quot;A String&quot;, # A link to human readable documentation for the API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]432 &quot;icons&quot;: { # Links to 16x16 and 32x32 icons representing the API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]433 &quot;x16&quot;: &quot;A String&quot;, # The URL of the 16x16 icon.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]434 &quot;x32&quot;: &quot;A String&quot;, # The URL of the 32x32 icon.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]435 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]436 &quot;discoveryRestUrl&quot;: &quot;A String&quot;, # The URL for the discovery REST document.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]437 &quot;id&quot;: &quot;A String&quot;, # The id of this API.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]438 },
439 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]440 &quot;kind&quot;: &quot;discovery#directoryList&quot;, # The kind for this response.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]441 &quot;discoveryVersion&quot;: &quot;v1&quot;, # Indicate the version of the Discovery API used to generate this doc.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]442 }</pre>
443</div>
444
445</body></html>