blob: f09d1f51b1649436b380bfd0db093acfd608396d [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_v1.html">Cloud Run API</a> . <a href="run_v1.projects.html">projects</a> . <a href="run_v1.projects.locations.html">locations</a> . <a href="run_v1.projects.locations.namespaces.html">namespaces</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 namespace.</p>
80<p class="toc_element">
81 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Rpc to update a namespace.</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 namespace.
87
88Args:
89 name: string, Required. The name of the namespace being retrieved. If needed, replace
90{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 { # Cloud Run fully managed: not supported
100 #
101 # Cloud Run on GKE: supported
102 #
103 # Namespace provides a scope for Names.
104 # Use of multiple namespaces is optional.
105 &quot;metadata&quot;: { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Standard object&#x27;s metadata.
106 # More info:
107 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
108 # persisted resources must have, which includes all objects users must create.
Bu Sun Kim65020912020-05-20 12:08:20 -0700109 &quot;annotations&quot;: { # (Optional)
110 #
111 # Annotations is an unstructured key value map stored with a resource that
112 # may be set by external tools to store and retrieve arbitrary metadata. They
113 # are not queryable and should be preserved when modifying objects. More
114 # info: http://kubernetes.io/docs/user-guide/annotations
115 &quot;a_key&quot;: &quot;A String&quot;,
116 },
117 &quot;generateName&quot;: &quot;A String&quot;, # (Optional)
118 #
119 # Cloud Run fully managed: not supported
120 #
121 # Cloud Run for Anthos: supported
122 #
123 # GenerateName is an optional prefix, used by the server, to generate a
124 # unique name ONLY IF the Name field has not been provided. If this field is
125 # used, the name returned to the client will be different than the name
126 # passed. This value will also be combined with a unique suffix. The provided
127 # value has the same validation rules as the Name field, and may be truncated
128 # by the length of the suffix required to make the value unique on the
129 # server.
130 #
131 # If this field is specified and the generated name exists, the server will
132 # NOT return a 409 - instead, it will either return 201 Created or 500 with
133 # Reason ServerTimeout indicating a unique name could not be found in the
134 # time allotted, and the client should retry (optionally after the time
135 # indicated in the Retry-After header).
136 #
137 # Applied only if Name is not specified.
138 # More info:
139 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
140 # string generateName = 2;
141 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
142 # Is required when creating
143 # resources, although some resources may allow a client to request the
144 # generation of an appropriate name automatically. Name is primarily intended
145 # for creation idempotence and configuration definition. Cannot be updated.
146 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
147 # +optional
148 &quot;deletionGracePeriodSeconds&quot;: 42, # (Optional)
149 #
150 # Cloud Run fully managed: not supported
151 #
152 # Cloud Run for Anthos: supported
153 #
154 # Number of seconds allowed for this object to gracefully terminate before
155 # it will be removed from the system. Only set when deletionTimestamp is also
156 # set. May only be shortened. Read-only.
157 &quot;clusterName&quot;: &quot;A String&quot;, # (Optional)
158 #
159 # Cloud Run fully managed: not supported
160 #
161 # Cloud Run for Anthos: supported
162 #
163 # The name of the cluster which the object belongs to.
164 # This is used to distinguish resources with same name and namespace in
165 # different clusters. This field is not set anywhere right now and apiserver
166 # is going to ignore it if set in create or update request.
167 &quot;finalizers&quot;: [ # (Optional)
168 #
169 # Cloud Run fully managed: not supported
170 #
171 # Cloud Run for Anthos: supported
172 #
173 # Must be empty before the object is deleted from the registry. Each entry
174 # is an identifier for the responsible component that will remove the entry
175 # from the list. If the deletionTimestamp of the object is non-nil, entries
176 # in this list can only be removed.
177 # +patchStrategy=merge
178 &quot;A String&quot;,
179 ],
180 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # (Optional)
181 #
182 # Cloud Run fully managed: not supported
183 #
184 # Cloud Run for Anthos: supported
185 #
186 # DeletionTimestamp is RFC 3339 date and time at which this resource will be
187 # deleted. This field is set by the server when a graceful deletion is
188 # requested by the user, and is not directly settable by a client. The
189 # resource is expected to be deleted (no longer visible from resource lists,
190 # and not reachable by name) after the time in this field, once the
191 # finalizers list is empty. As long as the finalizers list contains items,
192 # deletion is blocked. Once the deletionTimestamp is set, this value may not
193 # be unset or be set further into the future, although it may be shortened or
194 # the resource may be deleted prior to this time. For example, a user may
195 # request that a pod is deleted in 30 seconds. The Kubelet will react by
196 # sending a graceful termination signal to the containers in the pod. After
197 # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
198 # to the container and after cleanup, remove the pod from the API. In the
199 # presence of network partitions, this object may still exist after this
200 # timestamp, until an administrator or automated process can determine the
201 # resource is fully terminated.
202 # If not set, graceful deletion of the object has not been requested.
203 #
204 # Populated by the system when a graceful deletion is requested.
205 # Read-only.
206 # More info:
207 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
208 &quot;ownerReferences&quot;: [ # (Optional)
209 #
210 # Cloud Run fully managed: not supported
211 #
212 # Cloud Run for Anthos: supported
213 #
214 # List of objects that own this object. If ALL objects in the list have
215 # been deleted, this object will be garbage collected.
216 { # OwnerReference contains enough information to let you identify an owning
217 # object. Currently, an owning object must be in the same namespace, so there
218 # is no namespace field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700219 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
220 # +optional
221 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
222 # More info:
223 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
224 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
225 # the owner cannot be deleted from the key-value store until this
226 # reference is removed.
227 # Defaults to false.
228 # To set this field, a user needs &quot;delete&quot; permission of the owner,
229 # otherwise 422 (Unprocessable Entity) will be returned.
230 # +optional
231 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
232 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
233 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700234 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
235 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Bu Sun Kim65020912020-05-20 12:08:20 -0700236 },
237 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700238 &quot;creationTimestamp&quot;: &quot;A String&quot;, # (Optional)
239 #
240 # CreationTimestamp is a timestamp representing the server time when this
241 # object was created. It is not guaranteed to be set in happens-before order
242 # across separate operations. Clients may not set this value. It is
243 # represented in RFC3339 form and is in UTC.
244 #
245 # Populated by the system.
246 # Read-only.
247 # Null for lists.
248 # More info:
249 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
250 &quot;labels&quot;: { # (Optional)
251 #
252 # Map of string keys and values that can be used to organize and categorize
253 # (scope and select) objects. May match selectors of replication controllers
254 # and routes.
255 # More info: http://kubernetes.io/docs/user-guide/labels
256 &quot;a_key&quot;: &quot;A String&quot;,
257 },
258 &quot;generation&quot;: 42, # (Optional)
259 #
260 # A sequence number representing a specific generation of the desired state.
261 # Populated by the system. Read-only.
262 &quot;resourceVersion&quot;: &quot;A String&quot;, # (Optional)
263 #
264 # An opaque value that represents the internal version of this object that
265 # can be used by clients to determine when objects have changed. May be used
266 # for optimistic concurrency, change detection, and the watch operation on a
267 # resource or set of resources. Clients must treat these values as opaque and
268 # passed unmodified back to the server. They may only be valid for a
269 # particular resource or set of resources.
270 #
271 # Populated by the system.
272 # Read-only.
273 # Value must be treated as opaque by clients and .
274 # More info:
275 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
276 &quot;selfLink&quot;: &quot;A String&quot;, # (Optional)
277 #
278 # SelfLink is a URL representing this object.
279 # Populated by the system.
280 # Read-only.
281 # string selfLink = 4;
282 &quot;uid&quot;: &quot;A String&quot;, # (Optional)
283 #
284 # UID is the unique in time and space value for this object. It is typically
285 # generated by the server on successful creation of a resource and is not
286 # allowed to change on PUT operations.
287 #
288 # Populated by the system.
289 # Read-only.
290 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
291 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
292 # Cloud Run region. In Cloud Run the namespace must be equal to either the
293 # project ID or project number.
Bu Sun Kim65020912020-05-20 12:08:20 -0700294 },
295 &quot;status&quot;: { # Cloud Run fully managed: not supported # Status describes the current status of a Namespace.
296 # More info:
297 # https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
298 #
299 # Cloud Run on GKE: supported
300 #
301 # NamespaceStatus is information about the current status of a Namespace.
302 &quot;phase&quot;: &quot;A String&quot;, # Phase is the current lifecycle phase of the namespace.
303 # More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
304 },
305 &quot;spec&quot;: { # Cloud Run fully managed: not supported # Spec defines the behavior of the Namespace.
306 # More info:
307 # https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
308 #
309 # Cloud Run on GKE: supported
310 #
311 # NamespaceSpec describes the attributes on a Namespace.
312 &quot;finalizers&quot;: [ # Finalizers is an opaque list of values that must be empty to permanently
313 # remove object from storage. More info:
314 # https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
315 &quot;A String&quot;,
316 ],
317 },
318 }</pre>
319</div>
320
321<div class="method">
322 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
323 <pre>Rpc to update a namespace.
324
325Args:
326 name: string, Required. The name of the namespace being retrieved. If needed, replace
327{namespace_id} with the project ID. (required)
328 body: object, The request body.
329 The object takes the form of:
330
331{ # Cloud Run fully managed: not supported
332 #
333 # Cloud Run on GKE: supported
334 #
335 # Namespace provides a scope for Names.
336 # Use of multiple namespaces is optional.
337 &quot;metadata&quot;: { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Standard object&#x27;s metadata.
338 # More info:
339 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
340 # persisted resources must have, which includes all objects users must create.
Bu Sun Kim65020912020-05-20 12:08:20 -0700341 &quot;annotations&quot;: { # (Optional)
342 #
343 # Annotations is an unstructured key value map stored with a resource that
344 # may be set by external tools to store and retrieve arbitrary metadata. They
345 # are not queryable and should be preserved when modifying objects. More
346 # info: http://kubernetes.io/docs/user-guide/annotations
347 &quot;a_key&quot;: &quot;A String&quot;,
348 },
349 &quot;generateName&quot;: &quot;A String&quot;, # (Optional)
350 #
351 # Cloud Run fully managed: not supported
352 #
353 # Cloud Run for Anthos: supported
354 #
355 # GenerateName is an optional prefix, used by the server, to generate a
356 # unique name ONLY IF the Name field has not been provided. If this field is
357 # used, the name returned to the client will be different than the name
358 # passed. This value will also be combined with a unique suffix. The provided
359 # value has the same validation rules as the Name field, and may be truncated
360 # by the length of the suffix required to make the value unique on the
361 # server.
362 #
363 # If this field is specified and the generated name exists, the server will
364 # NOT return a 409 - instead, it will either return 201 Created or 500 with
365 # Reason ServerTimeout indicating a unique name could not be found in the
366 # time allotted, and the client should retry (optionally after the time
367 # indicated in the Retry-After header).
368 #
369 # Applied only if Name is not specified.
370 # More info:
371 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
372 # string generateName = 2;
373 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
374 # Is required when creating
375 # resources, although some resources may allow a client to request the
376 # generation of an appropriate name automatically. Name is primarily intended
377 # for creation idempotence and configuration definition. Cannot be updated.
378 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
379 # +optional
380 &quot;deletionGracePeriodSeconds&quot;: 42, # (Optional)
381 #
382 # Cloud Run fully managed: not supported
383 #
384 # Cloud Run for Anthos: supported
385 #
386 # Number of seconds allowed for this object to gracefully terminate before
387 # it will be removed from the system. Only set when deletionTimestamp is also
388 # set. May only be shortened. Read-only.
389 &quot;clusterName&quot;: &quot;A String&quot;, # (Optional)
390 #
391 # Cloud Run fully managed: not supported
392 #
393 # Cloud Run for Anthos: supported
394 #
395 # The name of the cluster which the object belongs to.
396 # This is used to distinguish resources with same name and namespace in
397 # different clusters. This field is not set anywhere right now and apiserver
398 # is going to ignore it if set in create or update request.
399 &quot;finalizers&quot;: [ # (Optional)
400 #
401 # Cloud Run fully managed: not supported
402 #
403 # Cloud Run for Anthos: supported
404 #
405 # Must be empty before the object is deleted from the registry. Each entry
406 # is an identifier for the responsible component that will remove the entry
407 # from the list. If the deletionTimestamp of the object is non-nil, entries
408 # in this list can only be removed.
409 # +patchStrategy=merge
410 &quot;A String&quot;,
411 ],
412 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # (Optional)
413 #
414 # Cloud Run fully managed: not supported
415 #
416 # Cloud Run for Anthos: supported
417 #
418 # DeletionTimestamp is RFC 3339 date and time at which this resource will be
419 # deleted. This field is set by the server when a graceful deletion is
420 # requested by the user, and is not directly settable by a client. The
421 # resource is expected to be deleted (no longer visible from resource lists,
422 # and not reachable by name) after the time in this field, once the
423 # finalizers list is empty. As long as the finalizers list contains items,
424 # deletion is blocked. Once the deletionTimestamp is set, this value may not
425 # be unset or be set further into the future, although it may be shortened or
426 # the resource may be deleted prior to this time. For example, a user may
427 # request that a pod is deleted in 30 seconds. The Kubelet will react by
428 # sending a graceful termination signal to the containers in the pod. After
429 # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
430 # to the container and after cleanup, remove the pod from the API. In the
431 # presence of network partitions, this object may still exist after this
432 # timestamp, until an administrator or automated process can determine the
433 # resource is fully terminated.
434 # If not set, graceful deletion of the object has not been requested.
435 #
436 # Populated by the system when a graceful deletion is requested.
437 # Read-only.
438 # More info:
439 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
440 &quot;ownerReferences&quot;: [ # (Optional)
441 #
442 # Cloud Run fully managed: not supported
443 #
444 # Cloud Run for Anthos: supported
445 #
446 # List of objects that own this object. If ALL objects in the list have
447 # been deleted, this object will be garbage collected.
448 { # OwnerReference contains enough information to let you identify an owning
449 # object. Currently, an owning object must be in the same namespace, so there
450 # is no namespace field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700451 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
452 # +optional
453 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
454 # More info:
455 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
456 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
457 # the owner cannot be deleted from the key-value store until this
458 # reference is removed.
459 # Defaults to false.
460 # To set this field, a user needs &quot;delete&quot; permission of the owner,
461 # otherwise 422 (Unprocessable Entity) will be returned.
462 # +optional
463 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
464 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
465 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700466 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
467 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Bu Sun Kim65020912020-05-20 12:08:20 -0700468 },
469 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700470 &quot;creationTimestamp&quot;: &quot;A String&quot;, # (Optional)
471 #
472 # CreationTimestamp is a timestamp representing the server time when this
473 # object was created. It is not guaranteed to be set in happens-before order
474 # across separate operations. Clients may not set this value. It is
475 # represented in RFC3339 form and is in UTC.
476 #
477 # Populated by the system.
478 # Read-only.
479 # Null for lists.
480 # More info:
481 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
482 &quot;labels&quot;: { # (Optional)
483 #
484 # Map of string keys and values that can be used to organize and categorize
485 # (scope and select) objects. May match selectors of replication controllers
486 # and routes.
487 # More info: http://kubernetes.io/docs/user-guide/labels
488 &quot;a_key&quot;: &quot;A String&quot;,
489 },
490 &quot;generation&quot;: 42, # (Optional)
491 #
492 # A sequence number representing a specific generation of the desired state.
493 # Populated by the system. Read-only.
494 &quot;resourceVersion&quot;: &quot;A String&quot;, # (Optional)
495 #
496 # An opaque value that represents the internal version of this object that
497 # can be used by clients to determine when objects have changed. May be used
498 # for optimistic concurrency, change detection, and the watch operation on a
499 # resource or set of resources. Clients must treat these values as opaque and
500 # passed unmodified back to the server. They may only be valid for a
501 # particular resource or set of resources.
502 #
503 # Populated by the system.
504 # Read-only.
505 # Value must be treated as opaque by clients and .
506 # More info:
507 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
508 &quot;selfLink&quot;: &quot;A String&quot;, # (Optional)
509 #
510 # SelfLink is a URL representing this object.
511 # Populated by the system.
512 # Read-only.
513 # string selfLink = 4;
514 &quot;uid&quot;: &quot;A String&quot;, # (Optional)
515 #
516 # UID is the unique in time and space value for this object. It is typically
517 # generated by the server on successful creation of a resource and is not
518 # allowed to change on PUT operations.
519 #
520 # Populated by the system.
521 # Read-only.
522 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
523 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
524 # Cloud Run region. In Cloud Run the namespace must be equal to either the
525 # project ID or project number.
Bu Sun Kim65020912020-05-20 12:08:20 -0700526 },
527 &quot;status&quot;: { # Cloud Run fully managed: not supported # Status describes the current status of a Namespace.
528 # More info:
529 # https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
530 #
531 # Cloud Run on GKE: supported
532 #
533 # NamespaceStatus is information about the current status of a Namespace.
534 &quot;phase&quot;: &quot;A String&quot;, # Phase is the current lifecycle phase of the namespace.
535 # More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
536 },
537 &quot;spec&quot;: { # Cloud Run fully managed: not supported # Spec defines the behavior of the Namespace.
538 # More info:
539 # https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
540 #
541 # Cloud Run on GKE: supported
542 #
543 # NamespaceSpec describes the attributes on a Namespace.
544 &quot;finalizers&quot;: [ # Finalizers is an opaque list of values that must be empty to permanently
545 # remove object from storage. More info:
546 # https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
547 &quot;A String&quot;,
548 ],
549 },
550}
551
552 updateMask: string, Required. Indicates which fields in the provided namespace to update.
553This field is currently unused.
554 x__xgafv: string, V1 error format.
555 Allowed values
556 1 - v1 error format
557 2 - v2 error format
558
559Returns:
560 An object of the form:
561
562 { # Cloud Run fully managed: not supported
563 #
564 # Cloud Run on GKE: supported
565 #
566 # Namespace provides a scope for Names.
567 # Use of multiple namespaces is optional.
568 &quot;metadata&quot;: { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Standard object&#x27;s metadata.
569 # More info:
570 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
571 # persisted resources must have, which includes all objects users must create.
Bu Sun Kim65020912020-05-20 12:08:20 -0700572 &quot;annotations&quot;: { # (Optional)
573 #
574 # Annotations is an unstructured key value map stored with a resource that
575 # may be set by external tools to store and retrieve arbitrary metadata. They
576 # are not queryable and should be preserved when modifying objects. More
577 # info: http://kubernetes.io/docs/user-guide/annotations
578 &quot;a_key&quot;: &quot;A String&quot;,
579 },
580 &quot;generateName&quot;: &quot;A String&quot;, # (Optional)
581 #
582 # Cloud Run fully managed: not supported
583 #
584 # Cloud Run for Anthos: supported
585 #
586 # GenerateName is an optional prefix, used by the server, to generate a
587 # unique name ONLY IF the Name field has not been provided. If this field is
588 # used, the name returned to the client will be different than the name
589 # passed. This value will also be combined with a unique suffix. The provided
590 # value has the same validation rules as the Name field, and may be truncated
591 # by the length of the suffix required to make the value unique on the
592 # server.
593 #
594 # If this field is specified and the generated name exists, the server will
595 # NOT return a 409 - instead, it will either return 201 Created or 500 with
596 # Reason ServerTimeout indicating a unique name could not be found in the
597 # time allotted, and the client should retry (optionally after the time
598 # indicated in the Retry-After header).
599 #
600 # Applied only if Name is not specified.
601 # More info:
602 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
603 # string generateName = 2;
604 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
605 # Is required when creating
606 # resources, although some resources may allow a client to request the
607 # generation of an appropriate name automatically. Name is primarily intended
608 # for creation idempotence and configuration definition. Cannot be updated.
609 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
610 # +optional
611 &quot;deletionGracePeriodSeconds&quot;: 42, # (Optional)
612 #
613 # Cloud Run fully managed: not supported
614 #
615 # Cloud Run for Anthos: supported
616 #
617 # Number of seconds allowed for this object to gracefully terminate before
618 # it will be removed from the system. Only set when deletionTimestamp is also
619 # set. May only be shortened. Read-only.
620 &quot;clusterName&quot;: &quot;A String&quot;, # (Optional)
621 #
622 # Cloud Run fully managed: not supported
623 #
624 # Cloud Run for Anthos: supported
625 #
626 # The name of the cluster which the object belongs to.
627 # This is used to distinguish resources with same name and namespace in
628 # different clusters. This field is not set anywhere right now and apiserver
629 # is going to ignore it if set in create or update request.
630 &quot;finalizers&quot;: [ # (Optional)
631 #
632 # Cloud Run fully managed: not supported
633 #
634 # Cloud Run for Anthos: supported
635 #
636 # Must be empty before the object is deleted from the registry. Each entry
637 # is an identifier for the responsible component that will remove the entry
638 # from the list. If the deletionTimestamp of the object is non-nil, entries
639 # in this list can only be removed.
640 # +patchStrategy=merge
641 &quot;A String&quot;,
642 ],
643 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # (Optional)
644 #
645 # Cloud Run fully managed: not supported
646 #
647 # Cloud Run for Anthos: supported
648 #
649 # DeletionTimestamp is RFC 3339 date and time at which this resource will be
650 # deleted. This field is set by the server when a graceful deletion is
651 # requested by the user, and is not directly settable by a client. The
652 # resource is expected to be deleted (no longer visible from resource lists,
653 # and not reachable by name) after the time in this field, once the
654 # finalizers list is empty. As long as the finalizers list contains items,
655 # deletion is blocked. Once the deletionTimestamp is set, this value may not
656 # be unset or be set further into the future, although it may be shortened or
657 # the resource may be deleted prior to this time. For example, a user may
658 # request that a pod is deleted in 30 seconds. The Kubelet will react by
659 # sending a graceful termination signal to the containers in the pod. After
660 # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
661 # to the container and after cleanup, remove the pod from the API. In the
662 # presence of network partitions, this object may still exist after this
663 # timestamp, until an administrator or automated process can determine the
664 # resource is fully terminated.
665 # If not set, graceful deletion of the object has not been requested.
666 #
667 # Populated by the system when a graceful deletion is requested.
668 # Read-only.
669 # More info:
670 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
671 &quot;ownerReferences&quot;: [ # (Optional)
672 #
673 # Cloud Run fully managed: not supported
674 #
675 # Cloud Run for Anthos: supported
676 #
677 # List of objects that own this object. If ALL objects in the list have
678 # been deleted, this object will be garbage collected.
679 { # OwnerReference contains enough information to let you identify an owning
680 # object. Currently, an owning object must be in the same namespace, so there
681 # is no namespace field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700682 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
683 # +optional
684 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
685 # More info:
686 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
687 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
688 # the owner cannot be deleted from the key-value store until this
689 # reference is removed.
690 # Defaults to false.
691 # To set this field, a user needs &quot;delete&quot; permission of the owner,
692 # otherwise 422 (Unprocessable Entity) will be returned.
693 # +optional
694 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
695 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
696 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700697 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
698 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Bu Sun Kim65020912020-05-20 12:08:20 -0700699 },
700 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700701 &quot;creationTimestamp&quot;: &quot;A String&quot;, # (Optional)
702 #
703 # CreationTimestamp is a timestamp representing the server time when this
704 # object was created. It is not guaranteed to be set in happens-before order
705 # across separate operations. Clients may not set this value. It is
706 # represented in RFC3339 form and is in UTC.
707 #
708 # Populated by the system.
709 # Read-only.
710 # Null for lists.
711 # More info:
712 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
713 &quot;labels&quot;: { # (Optional)
714 #
715 # Map of string keys and values that can be used to organize and categorize
716 # (scope and select) objects. May match selectors of replication controllers
717 # and routes.
718 # More info: http://kubernetes.io/docs/user-guide/labels
719 &quot;a_key&quot;: &quot;A String&quot;,
720 },
721 &quot;generation&quot;: 42, # (Optional)
722 #
723 # A sequence number representing a specific generation of the desired state.
724 # Populated by the system. Read-only.
725 &quot;resourceVersion&quot;: &quot;A String&quot;, # (Optional)
726 #
727 # An opaque value that represents the internal version of this object that
728 # can be used by clients to determine when objects have changed. May be used
729 # for optimistic concurrency, change detection, and the watch operation on a
730 # resource or set of resources. Clients must treat these values as opaque and
731 # passed unmodified back to the server. They may only be valid for a
732 # particular resource or set of resources.
733 #
734 # Populated by the system.
735 # Read-only.
736 # Value must be treated as opaque by clients and .
737 # More info:
738 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
739 &quot;selfLink&quot;: &quot;A String&quot;, # (Optional)
740 #
741 # SelfLink is a URL representing this object.
742 # Populated by the system.
743 # Read-only.
744 # string selfLink = 4;
745 &quot;uid&quot;: &quot;A String&quot;, # (Optional)
746 #
747 # UID is the unique in time and space value for this object. It is typically
748 # generated by the server on successful creation of a resource and is not
749 # allowed to change on PUT operations.
750 #
751 # Populated by the system.
752 # Read-only.
753 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
754 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
755 # Cloud Run region. In Cloud Run the namespace must be equal to either the
756 # project ID or project number.
Bu Sun Kim65020912020-05-20 12:08:20 -0700757 },
758 &quot;status&quot;: { # Cloud Run fully managed: not supported # Status describes the current status of a Namespace.
759 # More info:
760 # https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
761 #
762 # Cloud Run on GKE: supported
763 #
764 # NamespaceStatus is information about the current status of a Namespace.
765 &quot;phase&quot;: &quot;A String&quot;, # Phase is the current lifecycle phase of the namespace.
766 # More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
767 },
768 &quot;spec&quot;: { # Cloud Run fully managed: not supported # Spec defines the behavior of the Namespace.
769 # More info:
770 # https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
771 #
772 # Cloud Run on GKE: supported
773 #
774 # NamespaceSpec describes the attributes on a Namespace.
775 &quot;finalizers&quot;: [ # Finalizers is an opaque list of values that must be empty to permanently
776 # remove object from storage. More info:
777 # https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
778 &quot;A String&quot;,
779 ],
780 },
781 }</pre>
782</div>
783
784</body></html>