blob: e9ab1dd3bdd52f1dc1bc87b585a8c189fac99949 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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="run_v1beta1.html">Cloud Run API</a> . <a href="run_v1beta1.projects.html">projects</a> . <a href="run_v1beta1.projects.locations.html">locations</a> . <a href="run_v1beta1.projects.locations.customresourcedefinitions.html">customresourcedefinitions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Rpc to get information about a CustomResourceDefinition.</p>
80<p class="toc_element">
81 <code><a href="#list">list(parent, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, labelSelector=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Rpc to list custom resource definitions.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(name, x__xgafv=None)</code>
86 <pre>Rpc to get information about a CustomResourceDefinition.
87
88Args:
89 name: string, The name of the CustomResourceDefinition being retrieved. If needed,
90replace {namespace_id} with the project ID. (required)
91 x__xgafv: string, V1 error format.
92 Allowed values
93 1 - v1 error format
94 2 - v2 error format
95
96Returns:
97 An object of the form:
98
99 { # CustomResourceDefinition represents a resource that should be exposed on the
100 # API server. Its name MUST be in the format
101 # &lt;.spec.name&gt;.&lt;.spec.group&gt;.
102 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;k8s.apiextensions.io/v1beta1&quot;.
103 &quot;spec&quot;: { # CustomResourceDefinitionSpec describes how a user wants their resource to # Spec describes how the user wants the resources to appear
104 # appear
105 &quot;validation&quot;: { # CustomResourceValidation is a list of validation methods for CustomResources. # Validation describes the validation methods for CustomResources
106 # +optional
107 &quot;openAPIV3Schema&quot;: { # JSONSchemaProps is a JSON-Schema following Specification Draft 4 # OpenAPIV3Schema is the OpenAPI v3 schema to be validated against.
108 # +optional
109 # (http://json-schema.org/).
110 &quot;multipleOf&quot;: 3.14,
111 &quot;maximum&quot;: 3.14,
112 &quot;items&quot;: { # JSONSchemaPropsOrArray represents a value that can either be a
113 # JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization
114 # purposes.
115 &quot;jsonSchemas&quot;: [
116 # Object with schema name: JSONSchemaProps
117 ],
118 &quot;schema&quot;: # Object with schema name: JSONSchemaProps
119 },
120 &quot;schema&quot;: &quot;A String&quot;,
121 &quot;externalDocs&quot;: { # ExternalDocumentation allows referencing an external resource for extended
122 # documentation.
123 &quot;url&quot;: &quot;A String&quot;,
124 &quot;description&quot;: &quot;A String&quot;,
125 },
126 &quot;id&quot;: &quot;A String&quot;,
127 &quot;minimum&quot;: 3.14,
128 &quot;properties&quot;: {
129 &quot;a_key&quot;: # Object with schema name: JSONSchemaProps
130 },
131 &quot;ref&quot;: &quot;A String&quot;,
132 &quot;pattern&quot;: &quot;A String&quot;,
133 &quot;format&quot;: &quot;A String&quot;,
134 &quot;minLength&quot;: &quot;A String&quot;,
135 &quot;dependencies&quot;: {
136 &quot;a_key&quot;: { # JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.
137 &quot;property&quot;: [
138 &quot;A String&quot;,
139 ],
140 &quot;schema&quot;: # Object with schema name: JSONSchemaProps
141 },
142 },
143 &quot;type&quot;: &quot;A String&quot;,
144 &quot;not&quot;: # Object with schema name: JSONSchemaProps
145 &quot;minProperties&quot;: &quot;A String&quot;,
146 &quot;exclusiveMaximum&quot;: True or False,
147 &quot;patternProperties&quot;: {
148 &quot;a_key&quot;: # Object with schema name: JSONSchemaProps
149 },
150 &quot;additionalProperties&quot;: { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value.
151 # Defaults to true for the boolean property.
152 &quot;allows&quot;: True or False,
153 &quot;schema&quot;: # Object with schema name: JSONSchemaProps
154 },
155 &quot;maxItems&quot;: &quot;A String&quot;,
156 &quot;exclusiveMinimum&quot;: True or False,
157 &quot;additionalItems&quot;: { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value.
158 # Defaults to true for the boolean property.
159 &quot;allows&quot;: True or False,
160 &quot;schema&quot;: # Object with schema name: JSONSchemaProps
161 },
162 &quot;oneOf&quot;: [
163 # Object with schema name: JSONSchemaProps
164 ],
165 &quot;required&quot;: [
166 &quot;A String&quot;,
167 ],
168 &quot;minItems&quot;: &quot;A String&quot;,
169 &quot;title&quot;: &quot;A String&quot;,
170 &quot;definitions&quot;: {
171 &quot;a_key&quot;: # Object with schema name: JSONSchemaProps
172 },
173 &quot;enum&quot;: [
174 &quot;A String&quot;,
175 ],
176 &quot;uniqueItems&quot;: True or False,
177 &quot;anyOf&quot;: [
178 # Object with schema name: JSONSchemaProps
179 ],
180 &quot;description&quot;: &quot;A String&quot;,
181 &quot;default&quot;: { # JSON represents any valid JSON value.
182 # These types are supported: bool, int64, float64, string, []interface{},
183 # map[string]interface{} and nil.
184 &quot;raw&quot;: &quot;A String&quot;,
185 },
186 &quot;example&quot;: { # JSON represents any valid JSON value.
187 # These types are supported: bool, int64, float64, string, []interface{},
188 # map[string]interface{} and nil.
189 &quot;raw&quot;: &quot;A String&quot;,
190 },
191 &quot;allOf&quot;: [
192 # Object with schema name: JSONSchemaProps
193 ],
194 &quot;maxProperties&quot;: &quot;A String&quot;,
195 &quot;maxLength&quot;: &quot;A String&quot;,
196 },
197 },
198 &quot;group&quot;: &quot;A String&quot;, # Group is the group this resource belongs in
199 &quot;version&quot;: &quot;A String&quot;, # Version is the version this resource belongs in
200 # Should be always first item in Versions field if provided.
201 # Optional, but at least one of Version or Versions must be set.
202 # Deprecated: Please use `Versions`.
203 # +optional
204 &quot;names&quot;: { # CustomResourceDefinitionNames indicates the names to serve this # Names are the names used to describe this custom resource
205 # CustomResourceDefinition
206 &quot;listKind&quot;: &quot;A String&quot;, # ListKind is the serialized kind of the list for this resource. Defaults to
207 # &lt;kind&gt;List. +optional
208 &quot;shortNames&quot;: [ # ShortNames are short names for the resource. It must be all lowercase.
209 # +optional
210 &quot;A String&quot;,
211 ],
212 &quot;singular&quot;: &quot;A String&quot;, # Singular is the singular name of the resource. It must be all lowercase
213 # Defaults to lowercased &lt;kind&gt; +optional
214 &quot;plural&quot;: &quot;A String&quot;, # Plural is the plural name of the resource to serve. It must match the name
215 # of the CustomResourceDefinition-registration too: plural.group and it must
216 # be all lowercase.
217 &quot;categories&quot;: [ # Categories is a list of grouped resources custom resources belong to (e.g.
218 # &#x27;all&#x27;) +optional
219 &quot;A String&quot;,
220 ],
221 &quot;kind&quot;: &quot;A String&quot;, # Kind is the serialized kind of the resource. It is normally CamelCase and
222 # singular.
223 },
224 &quot;subresources&quot;: { # CustomResourceSubresources defines the status and scale subresources for # Subresources describes the subresources for CustomResources
225 # +optional
226 # CustomResources.
227 &quot;status&quot;: { # CustomResourceSubresourceStatus defines how to serve the status subresource # Status denotes the status subresource for CustomResources
228 # +optional
229 # for CustomResources. Status is represented by the `.status` JSON path inside
230 # of a CustomResource. When set,
231 # * exposes a /status subresource for the custom resource
232 # * PUT requests to the /status subresource take a custom resource object, and
233 # ignore changes to anything except the status stanza
234 # * PUT/POST/PATCH requests to the custom resource ignore changes to the status
235 # stanza
236 },
237 &quot;scale&quot;: { # CustomResourceSubresourceScale defines how to serve the scale subresource for # Scale denotes the scale subresource for CustomResources
238 # +optional
239 # CustomResources.
240 &quot;statusReplicasPath&quot;: &quot;A String&quot;, # StatusReplicasPath defines the JSON path inside of a CustomResource that
241 # corresponds to Scale.Status.Replicas. Only JSON paths without the array
242 # notation are allowed. Must be a JSON Path under .status. If there is no
243 # value under the given path in the CustomResource, the status replica value
244 # in the /scale subresource will default to 0.
245 &quot;labelSelectorPath&quot;: &quot;A String&quot;, # LabelSelectorPath defines the JSON path inside of a CustomResource that
246 # corresponds to Scale.Status.Selector. Only JSON paths without the array
247 # notation are allowed. Must be a JSON Path under .status. Must be set to
248 # work with HPA. If there is no value under the given path in the
249 # CustomResource, the status label selector value in the /scale subresource
250 # will default to the empty string. +optional
251 &quot;specReplicasPath&quot;: &quot;A String&quot;, # SpecReplicasPath defines the JSON path inside of a CustomResource that
252 # corresponds to Scale.Spec.Replicas. Only JSON paths without the array
253 # notation are allowed. Must be a JSON Path under .spec. If there is no value
254 # under the given path in the CustomResource, the /scale subresource will
255 # return an error on GET.
256 },
257 },
258 &quot;scope&quot;: &quot;A String&quot;, # Scope indicates whether this resource is cluster or namespace scoped.
259 # Default is namespaced
260 &quot;versions&quot;: [ # Versions is the list of all supported versions for this resource.
261 # If Version field is provided, this field is optional.
262 # Validation: All versions must use the same validation schema for now. i.e.,
263 # top level Validation field is applied to all of these versions. Order: The
264 # version name will be used to compute the order. If the version string is
265 # &quot;kube-like&quot;, it will sort above non &quot;kube-like&quot; version strings, which are
266 # ordered lexicographically. &quot;Kube-like&quot; versions start with a &quot;v&quot;, then are
267 # followed by a number (the major version), then optionally the string
268 # &quot;alpha&quot; or &quot;beta&quot; and another number (the minor version). These are sorted
269 # first by GA &gt; beta &gt; alpha (where GA is a version with no suffix such as
270 # beta or alpha), and then by comparing major version, then minor version. An
271 # example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1,
272 # v12alpha1, v11alpha2, foo1, foo10. +optional
273 {
274 &quot;name&quot;: &quot;A String&quot;, # Name is the version name, e.g. “v1”, “v2beta1”, etc.
275 &quot;served&quot;: True or False, # Served is a flag enabling/disabling this version from being served via REST
276 # APIs
277 &quot;storage&quot;: True or False, # Storage flags the version as storage version. There must be exactly one
278 # flagged as storage version.
279 },
280 ],
281 &quot;additionalPrinterColumns&quot;: [ # AdditionalPrinterColumns are additional columns shown e.g. in kubectl next
282 # to the name. Defaults to a created-at column. +optional
283 { # CustomResourceColumnDefinition specifies a column for server side printing.
284 &quot;description&quot;: &quot;A String&quot;, # description is a human readable description of this column.
285 # +optional
286 &quot;name&quot;: &quot;A String&quot;, # name is a human readable name for the column.
287 &quot;format&quot;: &quot;A String&quot;, # format is an optional OpenAPI type definition for this column. The &#x27;name&#x27;
288 # format is applied to the primary identifier column to assist in clients
289 # identifying column is the resource name. See
290 # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
291 # for more. +optional
292 &quot;type&quot;: &quot;A String&quot;, # type is an OpenAPI type definition for this column.
293 # See
294 # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
295 # for more.
296 &quot;jsonPath&quot;: &quot;A String&quot;, # JSONPath is a simple JSON path, i.e. with array notation.
297 &quot;priority&quot;: 42, # priority is an integer defining the relative importance of this column
298 # compared to others. Lower numbers are considered higher priority. Columns
299 # that may be omitted in limited space scenarios should be given a higher
300 # priority. +optional
301 },
302 ],
303 },
304 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case always &quot;CustomResourceDefinition&quot;.
305 &quot;metadata&quot;: { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this CustomResourceDefinition.
306 # persisted resources must have, which includes all objects users must create.
307 &quot;creationTimestamp&quot;: &quot;A String&quot;, # (Optional)
308 #
309 # CreationTimestamp is a timestamp representing the server time when this
310 # object was created. It is not guaranteed to be set in happens-before order
311 # across separate operations. Clients may not set this value. It is
312 # represented in RFC3339 form and is in UTC.
313 #
314 # Populated by the system.
315 # Read-only.
316 # Null for lists.
317 # More info:
318 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
319 &quot;labels&quot;: { # (Optional)
320 #
321 # Map of string keys and values that can be used to organize and categorize
322 # (scope and select) objects. May match selectors of replication controllers
323 # and routes.
324 # More info: http://kubernetes.io/docs/user-guide/labels
325 &quot;a_key&quot;: &quot;A String&quot;,
326 },
327 &quot;generation&quot;: 42, # (Optional)
328 #
329 # A sequence number representing a specific generation of the desired state.
330 # Populated by the system. Read-only.
331 &quot;resourceVersion&quot;: &quot;A String&quot;, # (Optional)
332 #
333 # An opaque value that represents the internal version of this object that
334 # can be used by clients to determine when objects have changed. May be used
335 # for optimistic concurrency, change detection, and the watch operation on a
336 # resource or set of resources. Clients must treat these values as opaque and
337 # passed unmodified back to the server. They may only be valid for a
338 # particular resource or set of resources.
339 #
340 # Populated by the system.
341 # Read-only.
342 # Value must be treated as opaque by clients and .
343 # More info:
344 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
345 &quot;selfLink&quot;: &quot;A String&quot;, # (Optional)
346 #
347 # SelfLink is a URL representing this object.
348 # Populated by the system.
349 # Read-only.
350 # string selfLink = 4;
351 &quot;uid&quot;: &quot;A String&quot;, # (Optional)
352 #
353 # UID is the unique in time and space value for this object. It is typically
354 # generated by the server on successful creation of a resource and is not
355 # allowed to change on PUT operations.
356 #
357 # Populated by the system.
358 # Read-only.
359 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
360 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
361 # Cloud Run region. In Cloud Run the namespace must be equal to either the
362 # project ID or project number.
363 &quot;annotations&quot;: { # (Optional)
364 #
365 # Annotations is an unstructured key value map stored with a resource that
366 # may be set by external tools to store and retrieve arbitrary metadata. They
367 # are not queryable and should be preserved when modifying objects. More
368 # info: http://kubernetes.io/docs/user-guide/annotations
369 &quot;a_key&quot;: &quot;A String&quot;,
370 },
371 &quot;generateName&quot;: &quot;A String&quot;, # (Optional)
372 #
373 # Cloud Run fully managed: not supported
374 #
375 # Cloud Run for Anthos: supported
376 #
377 # GenerateName is an optional prefix, used by the server, to generate a
378 # unique name ONLY IF the Name field has not been provided. If this field is
379 # used, the name returned to the client will be different than the name
380 # passed. This value will also be combined with a unique suffix. The provided
381 # value has the same validation rules as the Name field, and may be truncated
382 # by the length of the suffix required to make the value unique on the
383 # server.
384 #
385 # If this field is specified and the generated name exists, the server will
386 # NOT return a 409 - instead, it will either return 201 Created or 500 with
387 # Reason ServerTimeout indicating a unique name could not be found in the
388 # time allotted, and the client should retry (optionally after the time
389 # indicated in the Retry-After header).
390 #
391 # Applied only if Name is not specified.
392 # More info:
393 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
394 # string generateName = 2;
395 &quot;deletionGracePeriodSeconds&quot;: 42, # (Optional)
396 #
397 # Cloud Run fully managed: not supported
398 #
399 # Cloud Run for Anthos: supported
400 #
401 # Number of seconds allowed for this object to gracefully terminate before
402 # it will be removed from the system. Only set when deletionTimestamp is also
403 # set. May only be shortened. Read-only.
404 &quot;clusterName&quot;: &quot;A String&quot;, # (Optional)
405 #
406 # Cloud Run fully managed: not supported
407 #
408 # Cloud Run for Anthos: supported
409 #
410 # The name of the cluster which the object belongs to.
411 # This is used to distinguish resources with same name and namespace in
412 # different clusters. This field is not set anywhere right now and apiserver
413 # is going to ignore it if set in create or update request.
414 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
415 # Is required when creating
416 # resources, although some resources may allow a client to request the
417 # generation of an appropriate name automatically. Name is primarily intended
418 # for creation idempotence and configuration definition. Cannot be updated.
419 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
420 # +optional
421 &quot;finalizers&quot;: [ # (Optional)
422 #
423 # Cloud Run fully managed: not supported
424 #
425 # Cloud Run for Anthos: supported
426 #
427 # Must be empty before the object is deleted from the registry. Each entry
428 # is an identifier for the responsible component that will remove the entry
429 # from the list. If the deletionTimestamp of the object is non-nil, entries
430 # in this list can only be removed.
431 # +patchStrategy=merge
432 &quot;A String&quot;,
433 ],
434 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # (Optional)
435 #
436 # Cloud Run fully managed: not supported
437 #
438 # Cloud Run for Anthos: supported
439 #
440 # DeletionTimestamp is RFC 3339 date and time at which this resource will be
441 # deleted. This field is set by the server when a graceful deletion is
442 # requested by the user, and is not directly settable by a client. The
443 # resource is expected to be deleted (no longer visible from resource lists,
444 # and not reachable by name) after the time in this field, once the
445 # finalizers list is empty. As long as the finalizers list contains items,
446 # deletion is blocked. Once the deletionTimestamp is set, this value may not
447 # be unset or be set further into the future, although it may be shortened or
448 # the resource may be deleted prior to this time. For example, a user may
449 # request that a pod is deleted in 30 seconds. The Kubelet will react by
450 # sending a graceful termination signal to the containers in the pod. After
451 # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
452 # to the container and after cleanup, remove the pod from the API. In the
453 # presence of network partitions, this object may still exist after this
454 # timestamp, until an administrator or automated process can determine the
455 # resource is fully terminated.
456 # If not set, graceful deletion of the object has not been requested.
457 #
458 # Populated by the system when a graceful deletion is requested.
459 # Read-only.
460 # More info:
461 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
462 &quot;ownerReferences&quot;: [ # (Optional)
463 #
464 # Cloud Run fully managed: not supported
465 #
466 # Cloud Run for Anthos: supported
467 #
468 # List of objects that own this object. If ALL objects in the list have
469 # been deleted, this object will be garbage collected.
470 { # OwnerReference contains enough information to let you identify an owning
471 # object. Currently, an owning object must be in the same namespace, so there
472 # is no namespace field.
473 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
474 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
475 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
476 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
477 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
478 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
479 # +optional
480 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
481 # More info:
482 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
483 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
484 # the owner cannot be deleted from the key-value store until this
485 # reference is removed.
486 # Defaults to false.
487 # To set this field, a user needs &quot;delete&quot; permission of the owner,
488 # otherwise 422 (Unprocessable Entity) will be returned.
489 # +optional
490 },
491 ],
492 },
493 }</pre>
494</div>
495
496<div class="method">
497 <code class="details" id="list">list(parent, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, labelSelector=None, x__xgafv=None)</code>
498 <pre>Rpc to list custom resource definitions.
499
500Args:
501 parent: string, The project ID or project number from which the storages should
502be listed. (required)
503 resourceVersion: string, The baseline resource version from which the list or watch operation should
504start. Not currently used by Cloud Run.
505 includeUninitialized: boolean, Not currently used by Cloud Run.
506 fieldSelector: string, Allows to filter resources based on a specific value for a field name.
507Send this in a query string format. i.e. &#x27;metadata.name%3Dlorem&#x27;.
508Not currently used by Cloud Run.
509 continue: string, Optional encoded string to continue paging.
510 limit: integer, A parameter
511 watch: boolean, Flag that indicates that the client expects to watch this resource as well.
512Not currently used by Cloud Run.
513 labelSelector: string, Allows to filter resources based on a label. Supported operations are
514=, !=, exists, in, and notIn.
515 x__xgafv: string, V1 error format.
516 Allowed values
517 1 - v1 error format
518 2 - v2 error format
519
520Returns:
521 An object of the form:
522
523 {
524 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;k8s.apiextensions.io/v1beta1&quot;.
525 &quot;kind&quot;: &quot;A String&quot;, # The kind of this resource, in this case &quot;CustomResourceDefinitionList&quot;.
526 &quot;unreachable&quot;: [ # Locations that could not be reached.
527 &quot;A String&quot;,
528 ],
529 &quot;metadata&quot;: { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this CustomResourceDefinition list.
530 # lists and various status objects. A resource may have only one of
531 # {ObjectMeta, ListMeta}.
532 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object.
533 # Populated by the system.
534 # Read-only.
535 # +optional
536 &quot;resourceVersion&quot;: &quot;A String&quot;, # String that identifies the server&#x27;s internal version of this object that
537 # can be used by clients to determine when objects have changed. Value must
538 # be treated as opaque by clients and passed unmodified back to the server.
539 # Populated by the system.
540 # Read-only.
541 # More info:
542 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
543 # +optional
544 &quot;continue&quot;: &quot;A String&quot;, # continue may be set if the user set a limit on the number of items
545 # returned, and indicates that the server has more data available. The value
546 # is opaque and may be used to issue another request to the endpoint that
547 # served this list to retrieve the next set of available objects. Continuing
548 # a list may not be possible if the server configuration has changed or more
549 # than a few minutes have passed. The resourceVersion field returned when
550 # using this continue value will be identical to the value in the first
551 # response.
552 },
553 &quot;items&quot;: [ # List of CustomResourceDefinitions.
554 { # CustomResourceDefinition represents a resource that should be exposed on the
555 # API server. Its name MUST be in the format
556 # &lt;.spec.name&gt;.&lt;.spec.group&gt;.
557 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;k8s.apiextensions.io/v1beta1&quot;.
558 &quot;spec&quot;: { # CustomResourceDefinitionSpec describes how a user wants their resource to # Spec describes how the user wants the resources to appear
559 # appear
560 &quot;validation&quot;: { # CustomResourceValidation is a list of validation methods for CustomResources. # Validation describes the validation methods for CustomResources
561 # +optional
562 &quot;openAPIV3Schema&quot;: { # JSONSchemaProps is a JSON-Schema following Specification Draft 4 # OpenAPIV3Schema is the OpenAPI v3 schema to be validated against.
563 # +optional
564 # (http://json-schema.org/).
565 &quot;multipleOf&quot;: 3.14,
566 &quot;maximum&quot;: 3.14,
567 &quot;items&quot;: { # JSONSchemaPropsOrArray represents a value that can either be a
568 # JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization
569 # purposes.
570 &quot;jsonSchemas&quot;: [
571 # Object with schema name: JSONSchemaProps
572 ],
573 &quot;schema&quot;: # Object with schema name: JSONSchemaProps
574 },
575 &quot;schema&quot;: &quot;A String&quot;,
576 &quot;externalDocs&quot;: { # ExternalDocumentation allows referencing an external resource for extended
577 # documentation.
578 &quot;url&quot;: &quot;A String&quot;,
579 &quot;description&quot;: &quot;A String&quot;,
580 },
581 &quot;id&quot;: &quot;A String&quot;,
582 &quot;minimum&quot;: 3.14,
583 &quot;properties&quot;: {
584 &quot;a_key&quot;: # Object with schema name: JSONSchemaProps
585 },
586 &quot;ref&quot;: &quot;A String&quot;,
587 &quot;pattern&quot;: &quot;A String&quot;,
588 &quot;format&quot;: &quot;A String&quot;,
589 &quot;minLength&quot;: &quot;A String&quot;,
590 &quot;dependencies&quot;: {
591 &quot;a_key&quot;: { # JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.
592 &quot;property&quot;: [
593 &quot;A String&quot;,
594 ],
595 &quot;schema&quot;: # Object with schema name: JSONSchemaProps
596 },
597 },
598 &quot;type&quot;: &quot;A String&quot;,
599 &quot;not&quot;: # Object with schema name: JSONSchemaProps
600 &quot;minProperties&quot;: &quot;A String&quot;,
601 &quot;exclusiveMaximum&quot;: True or False,
602 &quot;patternProperties&quot;: {
603 &quot;a_key&quot;: # Object with schema name: JSONSchemaProps
604 },
605 &quot;additionalProperties&quot;: { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value.
606 # Defaults to true for the boolean property.
607 &quot;allows&quot;: True or False,
608 &quot;schema&quot;: # Object with schema name: JSONSchemaProps
609 },
610 &quot;maxItems&quot;: &quot;A String&quot;,
611 &quot;exclusiveMinimum&quot;: True or False,
612 &quot;additionalItems&quot;: { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value.
613 # Defaults to true for the boolean property.
614 &quot;allows&quot;: True or False,
615 &quot;schema&quot;: # Object with schema name: JSONSchemaProps
616 },
617 &quot;oneOf&quot;: [
618 # Object with schema name: JSONSchemaProps
619 ],
620 &quot;required&quot;: [
621 &quot;A String&quot;,
622 ],
623 &quot;minItems&quot;: &quot;A String&quot;,
624 &quot;title&quot;: &quot;A String&quot;,
625 &quot;definitions&quot;: {
626 &quot;a_key&quot;: # Object with schema name: JSONSchemaProps
627 },
628 &quot;enum&quot;: [
629 &quot;A String&quot;,
630 ],
631 &quot;uniqueItems&quot;: True or False,
632 &quot;anyOf&quot;: [
633 # Object with schema name: JSONSchemaProps
634 ],
635 &quot;description&quot;: &quot;A String&quot;,
636 &quot;default&quot;: { # JSON represents any valid JSON value.
637 # These types are supported: bool, int64, float64, string, []interface{},
638 # map[string]interface{} and nil.
639 &quot;raw&quot;: &quot;A String&quot;,
640 },
641 &quot;example&quot;: { # JSON represents any valid JSON value.
642 # These types are supported: bool, int64, float64, string, []interface{},
643 # map[string]interface{} and nil.
644 &quot;raw&quot;: &quot;A String&quot;,
645 },
646 &quot;allOf&quot;: [
647 # Object with schema name: JSONSchemaProps
648 ],
649 &quot;maxProperties&quot;: &quot;A String&quot;,
650 &quot;maxLength&quot;: &quot;A String&quot;,
651 },
652 },
653 &quot;group&quot;: &quot;A String&quot;, # Group is the group this resource belongs in
654 &quot;version&quot;: &quot;A String&quot;, # Version is the version this resource belongs in
655 # Should be always first item in Versions field if provided.
656 # Optional, but at least one of Version or Versions must be set.
657 # Deprecated: Please use `Versions`.
658 # +optional
659 &quot;names&quot;: { # CustomResourceDefinitionNames indicates the names to serve this # Names are the names used to describe this custom resource
660 # CustomResourceDefinition
661 &quot;listKind&quot;: &quot;A String&quot;, # ListKind is the serialized kind of the list for this resource. Defaults to
662 # &lt;kind&gt;List. +optional
663 &quot;shortNames&quot;: [ # ShortNames are short names for the resource. It must be all lowercase.
664 # +optional
665 &quot;A String&quot;,
666 ],
667 &quot;singular&quot;: &quot;A String&quot;, # Singular is the singular name of the resource. It must be all lowercase
668 # Defaults to lowercased &lt;kind&gt; +optional
669 &quot;plural&quot;: &quot;A String&quot;, # Plural is the plural name of the resource to serve. It must match the name
670 # of the CustomResourceDefinition-registration too: plural.group and it must
671 # be all lowercase.
672 &quot;categories&quot;: [ # Categories is a list of grouped resources custom resources belong to (e.g.
673 # &#x27;all&#x27;) +optional
674 &quot;A String&quot;,
675 ],
676 &quot;kind&quot;: &quot;A String&quot;, # Kind is the serialized kind of the resource. It is normally CamelCase and
677 # singular.
678 },
679 &quot;subresources&quot;: { # CustomResourceSubresources defines the status and scale subresources for # Subresources describes the subresources for CustomResources
680 # +optional
681 # CustomResources.
682 &quot;status&quot;: { # CustomResourceSubresourceStatus defines how to serve the status subresource # Status denotes the status subresource for CustomResources
683 # +optional
684 # for CustomResources. Status is represented by the `.status` JSON path inside
685 # of a CustomResource. When set,
686 # * exposes a /status subresource for the custom resource
687 # * PUT requests to the /status subresource take a custom resource object, and
688 # ignore changes to anything except the status stanza
689 # * PUT/POST/PATCH requests to the custom resource ignore changes to the status
690 # stanza
691 },
692 &quot;scale&quot;: { # CustomResourceSubresourceScale defines how to serve the scale subresource for # Scale denotes the scale subresource for CustomResources
693 # +optional
694 # CustomResources.
695 &quot;statusReplicasPath&quot;: &quot;A String&quot;, # StatusReplicasPath defines the JSON path inside of a CustomResource that
696 # corresponds to Scale.Status.Replicas. Only JSON paths without the array
697 # notation are allowed. Must be a JSON Path under .status. If there is no
698 # value under the given path in the CustomResource, the status replica value
699 # in the /scale subresource will default to 0.
700 &quot;labelSelectorPath&quot;: &quot;A String&quot;, # LabelSelectorPath defines the JSON path inside of a CustomResource that
701 # corresponds to Scale.Status.Selector. Only JSON paths without the array
702 # notation are allowed. Must be a JSON Path under .status. Must be set to
703 # work with HPA. If there is no value under the given path in the
704 # CustomResource, the status label selector value in the /scale subresource
705 # will default to the empty string. +optional
706 &quot;specReplicasPath&quot;: &quot;A String&quot;, # SpecReplicasPath defines the JSON path inside of a CustomResource that
707 # corresponds to Scale.Spec.Replicas. Only JSON paths without the array
708 # notation are allowed. Must be a JSON Path under .spec. If there is no value
709 # under the given path in the CustomResource, the /scale subresource will
710 # return an error on GET.
711 },
712 },
713 &quot;scope&quot;: &quot;A String&quot;, # Scope indicates whether this resource is cluster or namespace scoped.
714 # Default is namespaced
715 &quot;versions&quot;: [ # Versions is the list of all supported versions for this resource.
716 # If Version field is provided, this field is optional.
717 # Validation: All versions must use the same validation schema for now. i.e.,
718 # top level Validation field is applied to all of these versions. Order: The
719 # version name will be used to compute the order. If the version string is
720 # &quot;kube-like&quot;, it will sort above non &quot;kube-like&quot; version strings, which are
721 # ordered lexicographically. &quot;Kube-like&quot; versions start with a &quot;v&quot;, then are
722 # followed by a number (the major version), then optionally the string
723 # &quot;alpha&quot; or &quot;beta&quot; and another number (the minor version). These are sorted
724 # first by GA &gt; beta &gt; alpha (where GA is a version with no suffix such as
725 # beta or alpha), and then by comparing major version, then minor version. An
726 # example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1,
727 # v12alpha1, v11alpha2, foo1, foo10. +optional
728 {
729 &quot;name&quot;: &quot;A String&quot;, # Name is the version name, e.g. “v1”, “v2beta1”, etc.
730 &quot;served&quot;: True or False, # Served is a flag enabling/disabling this version from being served via REST
731 # APIs
732 &quot;storage&quot;: True or False, # Storage flags the version as storage version. There must be exactly one
733 # flagged as storage version.
734 },
735 ],
736 &quot;additionalPrinterColumns&quot;: [ # AdditionalPrinterColumns are additional columns shown e.g. in kubectl next
737 # to the name. Defaults to a created-at column. +optional
738 { # CustomResourceColumnDefinition specifies a column for server side printing.
739 &quot;description&quot;: &quot;A String&quot;, # description is a human readable description of this column.
740 # +optional
741 &quot;name&quot;: &quot;A String&quot;, # name is a human readable name for the column.
742 &quot;format&quot;: &quot;A String&quot;, # format is an optional OpenAPI type definition for this column. The &#x27;name&#x27;
743 # format is applied to the primary identifier column to assist in clients
744 # identifying column is the resource name. See
745 # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
746 # for more. +optional
747 &quot;type&quot;: &quot;A String&quot;, # type is an OpenAPI type definition for this column.
748 # See
749 # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
750 # for more.
751 &quot;jsonPath&quot;: &quot;A String&quot;, # JSONPath is a simple JSON path, i.e. with array notation.
752 &quot;priority&quot;: 42, # priority is an integer defining the relative importance of this column
753 # compared to others. Lower numbers are considered higher priority. Columns
754 # that may be omitted in limited space scenarios should be given a higher
755 # priority. +optional
756 },
757 ],
758 },
759 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case always &quot;CustomResourceDefinition&quot;.
760 &quot;metadata&quot;: { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this CustomResourceDefinition.
761 # persisted resources must have, which includes all objects users must create.
762 &quot;creationTimestamp&quot;: &quot;A String&quot;, # (Optional)
763 #
764 # CreationTimestamp is a timestamp representing the server time when this
765 # object was created. It is not guaranteed to be set in happens-before order
766 # across separate operations. Clients may not set this value. It is
767 # represented in RFC3339 form and is in UTC.
768 #
769 # Populated by the system.
770 # Read-only.
771 # Null for lists.
772 # More info:
773 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
774 &quot;labels&quot;: { # (Optional)
775 #
776 # Map of string keys and values that can be used to organize and categorize
777 # (scope and select) objects. May match selectors of replication controllers
778 # and routes.
779 # More info: http://kubernetes.io/docs/user-guide/labels
780 &quot;a_key&quot;: &quot;A String&quot;,
781 },
782 &quot;generation&quot;: 42, # (Optional)
783 #
784 # A sequence number representing a specific generation of the desired state.
785 # Populated by the system. Read-only.
786 &quot;resourceVersion&quot;: &quot;A String&quot;, # (Optional)
787 #
788 # An opaque value that represents the internal version of this object that
789 # can be used by clients to determine when objects have changed. May be used
790 # for optimistic concurrency, change detection, and the watch operation on a
791 # resource or set of resources. Clients must treat these values as opaque and
792 # passed unmodified back to the server. They may only be valid for a
793 # particular resource or set of resources.
794 #
795 # Populated by the system.
796 # Read-only.
797 # Value must be treated as opaque by clients and .
798 # More info:
799 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
800 &quot;selfLink&quot;: &quot;A String&quot;, # (Optional)
801 #
802 # SelfLink is a URL representing this object.
803 # Populated by the system.
804 # Read-only.
805 # string selfLink = 4;
806 &quot;uid&quot;: &quot;A String&quot;, # (Optional)
807 #
808 # UID is the unique in time and space value for this object. It is typically
809 # generated by the server on successful creation of a resource and is not
810 # allowed to change on PUT operations.
811 #
812 # Populated by the system.
813 # Read-only.
814 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
815 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
816 # Cloud Run region. In Cloud Run the namespace must be equal to either the
817 # project ID or project number.
818 &quot;annotations&quot;: { # (Optional)
819 #
820 # Annotations is an unstructured key value map stored with a resource that
821 # may be set by external tools to store and retrieve arbitrary metadata. They
822 # are not queryable and should be preserved when modifying objects. More
823 # info: http://kubernetes.io/docs/user-guide/annotations
824 &quot;a_key&quot;: &quot;A String&quot;,
825 },
826 &quot;generateName&quot;: &quot;A String&quot;, # (Optional)
827 #
828 # Cloud Run fully managed: not supported
829 #
830 # Cloud Run for Anthos: supported
831 #
832 # GenerateName is an optional prefix, used by the server, to generate a
833 # unique name ONLY IF the Name field has not been provided. If this field is
834 # used, the name returned to the client will be different than the name
835 # passed. This value will also be combined with a unique suffix. The provided
836 # value has the same validation rules as the Name field, and may be truncated
837 # by the length of the suffix required to make the value unique on the
838 # server.
839 #
840 # If this field is specified and the generated name exists, the server will
841 # NOT return a 409 - instead, it will either return 201 Created or 500 with
842 # Reason ServerTimeout indicating a unique name could not be found in the
843 # time allotted, and the client should retry (optionally after the time
844 # indicated in the Retry-After header).
845 #
846 # Applied only if Name is not specified.
847 # More info:
848 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
849 # string generateName = 2;
850 &quot;deletionGracePeriodSeconds&quot;: 42, # (Optional)
851 #
852 # Cloud Run fully managed: not supported
853 #
854 # Cloud Run for Anthos: supported
855 #
856 # Number of seconds allowed for this object to gracefully terminate before
857 # it will be removed from the system. Only set when deletionTimestamp is also
858 # set. May only be shortened. Read-only.
859 &quot;clusterName&quot;: &quot;A String&quot;, # (Optional)
860 #
861 # Cloud Run fully managed: not supported
862 #
863 # Cloud Run for Anthos: supported
864 #
865 # The name of the cluster which the object belongs to.
866 # This is used to distinguish resources with same name and namespace in
867 # different clusters. This field is not set anywhere right now and apiserver
868 # is going to ignore it if set in create or update request.
869 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
870 # Is required when creating
871 # resources, although some resources may allow a client to request the
872 # generation of an appropriate name automatically. Name is primarily intended
873 # for creation idempotence and configuration definition. Cannot be updated.
874 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
875 # +optional
876 &quot;finalizers&quot;: [ # (Optional)
877 #
878 # Cloud Run fully managed: not supported
879 #
880 # Cloud Run for Anthos: supported
881 #
882 # Must be empty before the object is deleted from the registry. Each entry
883 # is an identifier for the responsible component that will remove the entry
884 # from the list. If the deletionTimestamp of the object is non-nil, entries
885 # in this list can only be removed.
886 # +patchStrategy=merge
887 &quot;A String&quot;,
888 ],
889 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # (Optional)
890 #
891 # Cloud Run fully managed: not supported
892 #
893 # Cloud Run for Anthos: supported
894 #
895 # DeletionTimestamp is RFC 3339 date and time at which this resource will be
896 # deleted. This field is set by the server when a graceful deletion is
897 # requested by the user, and is not directly settable by a client. The
898 # resource is expected to be deleted (no longer visible from resource lists,
899 # and not reachable by name) after the time in this field, once the
900 # finalizers list is empty. As long as the finalizers list contains items,
901 # deletion is blocked. Once the deletionTimestamp is set, this value may not
902 # be unset or be set further into the future, although it may be shortened or
903 # the resource may be deleted prior to this time. For example, a user may
904 # request that a pod is deleted in 30 seconds. The Kubelet will react by
905 # sending a graceful termination signal to the containers in the pod. After
906 # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
907 # to the container and after cleanup, remove the pod from the API. In the
908 # presence of network partitions, this object may still exist after this
909 # timestamp, until an administrator or automated process can determine the
910 # resource is fully terminated.
911 # If not set, graceful deletion of the object has not been requested.
912 #
913 # Populated by the system when a graceful deletion is requested.
914 # Read-only.
915 # More info:
916 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
917 &quot;ownerReferences&quot;: [ # (Optional)
918 #
919 # Cloud Run fully managed: not supported
920 #
921 # Cloud Run for Anthos: supported
922 #
923 # List of objects that own this object. If ALL objects in the list have
924 # been deleted, this object will be garbage collected.
925 { # OwnerReference contains enough information to let you identify an owning
926 # object. Currently, an owning object must be in the same namespace, so there
927 # is no namespace field.
928 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
929 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
930 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
931 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
932 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
933 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
934 # +optional
935 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
936 # More info:
937 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
938 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
939 # the owner cannot be deleted from the key-value store until this
940 # reference is removed.
941 # Defaults to false.
942 # To set this field, a user needs &quot;delete&quot; permission of the owner,
943 # otherwise 422 (Unprocessable Entity) will be returned.
944 # +optional
945 },
946 ],
947 },
948 },
949 ],
950 }</pre>
951</div>
952
953</body></html>