blob: 0334e12f2f49c88562e86c23a4108453f9774b14 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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_v1alpha1.html">Cloud Run API</a> . <a href="run_v1alpha1.namespaces.html">namespaces</a> . <a href="run_v1alpha1.namespaces.domainmappings.html">domainmappings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Creates a new domain mapping.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <code><a href="#delete">delete(name, orphanDependents=None, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Rpc to delete a domain mapping.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Rpc to get information about a domain mapping.</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070087 <code><a href="#list">list(parent, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Rpc to list domain mappings.</p>
89<h3>Method Details</h3>
90<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070091 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092 <pre>Creates a new domain mapping.
93
94Args:
95 parent: string, The project ID or project number in which this domain mapping should be
96created. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -070097 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098 The object takes the form of:
99
Bu Sun Kim65020912020-05-20 12:08:20 -0700100{ # Resource to hold the state and status of a user&#x27;s domain mapping.
101 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
102 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.
103 # all objects users must create.
104 &quot;annotations&quot;: { # Annotations is an unstructured key value map stored with a resource that
105 # may be set by external tools to store and retrieve arbitrary metadata. They
106 # are not queryable and should be preserved when modifying objects. More
107 # info: http://kubernetes.io/docs/user-guide/annotations +optional
108 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700110 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run.
111 #
112 # GenerateName is an optional prefix, used by the server, to generate a
113 # unique name ONLY IF the Name field has not been provided. If this field is
114 # used, the name returned to the client will be different than the name
115 # passed. This value will also be combined with a unique suffix. The provided
116 # value has the same validation rules as the Name field, and may be truncated
117 # by the length of the suffix required to make the value unique on the
118 # server.
119 #
120 # If this field is specified and the generated name exists, the server will
121 # NOT return a 409 - instead, it will either return 201 Created or 500 with
122 # Reason ServerTimeout indicating a unique name could not be found in the
123 # time allotted, and the client should retry (optionally after the time
124 # indicated in the Retry-After header).
125 #
126 # Applied only if Name is not specified.
127 # More info:
128 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
129 # +optional
130 # string generateName = 2;
131 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
132 # Is required when creating
133 # resources, although some resources may allow a client to request the
134 # generation of an appropriate name automatically. Name is primarily intended
135 # for creation idempotence and configuration definition. Cannot be updated.
136 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
137 # +optional
138 &quot;clusterName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run.
139 #
140 # The name of the cluster which the object belongs to.
141 # This is used to distinguish resources with same name and namespace in
142 # different clusters. This field is not set anywhere right now and apiserver
143 # is going to ignore it if set in create or update request. +optional
144 &quot;deletionGracePeriodSeconds&quot;: 42, # Not currently supported by Cloud Run.
145 #
146 # Number of seconds allowed for this object to gracefully terminate before
147 # it will be removed from the system. Only set when deletionTimestamp is also
148 # set. May only be shortened. Read-only. +optional
149 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run.
150 #
151 # Must be empty before the object is deleted from the registry. Each entry
152 # is an identifier for the responsible component that will remove the entry
153 # from the list. If the deletionTimestamp of the object is non-nil, entries
154 # in this list can only be removed.
155 # +optional
156 # +patchStrategy=merge
157 &quot;A String&quot;,
158 ],
159 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # DeletionTimestamp is RFC 3339 date and time at which this resource will be
160 # deleted. This field is set by the server when a graceful deletion is
161 # requested by the user, and is not directly settable by a client. The
162 # resource is expected to be deleted (no longer visible from resource lists,
163 # and not reachable by name) after the time in this field, once the
164 # finalizers list is empty. As long as the finalizers list contains items,
165 # deletion is blocked. Once the deletionTimestamp is set, this value may not
166 # be unset or be set further into the future, although it may be shortened or
167 # the resource may be deleted prior to this time. For example, a user may
168 # request that a pod is deleted in 30 seconds. The Kubelet will react by
169 # sending a graceful termination signal to the containers in the pod. After
170 # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
171 # to the container and after cleanup, remove the pod from the API. In the
172 # presence of network partitions, this object may still exist after this
173 # timestamp, until an administrator or automated process can determine the
174 # resource is fully terminated.
175 # If not set, graceful deletion of the object has not been requested.
176 #
177 # Populated by the system when a graceful deletion is requested.
178 # Read-only.
179 # More info:
180 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
181 # +optional
182 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have
183 # been deleted, this object will be garbage collected.
184 # +optional
185 { # OwnerReference contains enough information to let you identify an owning
186 # object. Currently, an owning object must be in the same namespace, so there
187 # is no namespace field.
188 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
189 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
190 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
191 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
192 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
193 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
194 # +optional
195 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
196 # More info:
197 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
198 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
199 # the owner cannot be deleted from the key-value store until this
200 # reference is removed.
201 # Defaults to false.
202 # To set this field, a user needs &quot;delete&quot; permission of the owner,
203 # otherwise 422 (Unprocessable Entity) will be returned.
204 # +optional
205 },
206 ],
207 &quot;creationTimestamp&quot;: &quot;A String&quot;, # CreationTimestamp is a timestamp representing the server time when this
208 # object was created. It is not guaranteed to be set in happens-before order
209 # across separate operations. Clients may not set this value. It is
210 # represented in RFC3339 form and is in UTC.
211 #
212 # Populated by the system.
213 # Read-only.
214 # Null for lists.
215 # More info:
216 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
217 # +optional
218 &quot;labels&quot;: { # Map of string keys and values that can be used to organize and categorize
219 # (scope and select) objects. May match selectors of replication controllers
220 # and routes.
221 # More info: http://kubernetes.io/docs/user-guide/labels
222 # +optional
223 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700224 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700225 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state.
226 # Populated by the system. Read-only.
227 # +optional
228 &quot;resourceVersion&quot;: &quot;A String&quot;, # An opaque value that represents the internal version of this object that
229 # can be used by clients to determine when objects have changed. May be used
230 # for optimistic concurrency, change detection, and the watch operation on a
231 # resource or set of resources. Clients must treat these values as opaque and
232 # passed unmodified back to the server. They may only be valid for a
233 # particular resource or set of resources.
234 #
235 # Populated by the system.
236 # Read-only.
237 # Value must be treated as opaque by clients and .
238 # More info:
239 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
240 # +optional
241 &quot;uid&quot;: &quot;A String&quot;, # UID is the unique in time and space value for this object. It is typically
242 # generated by the server on successful creation of a resource and is not
243 # allowed to change on PUT operations.
244 #
245 # Populated by the system.
246 # Read-only.
247 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
248 # +optional
249 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object.
250 # Populated by the system.
251 # Read-only.
252 # +optional
253 # string selfLink = 4;
254 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
255 # Cloud Run region. In Cloud Run the namespace must be equal to either the
256 # project ID or project number.
257 },
258 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
259 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These
260 # records must be added to the domain&#x27;s DNS configuration in order to
261 # serve the application via this domain mapping.
262 { # A DNS resource record.
263 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for
264 # `CNAME` records. Example: &#x27;www&#x27;.
265 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
266 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035
267 # (section 5) and RFC 1034 (section 3.6.1).
268 },
269 ],
270 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
271 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state
272 # of the DomainMapping.
273 { # DomainMappingCondition contains state information for a DomainMapping.
274 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status.
275 # +optional
276 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another.
277 # +optional
278 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
279 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info
280 # +optional
281 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status.
282 # +optional
283 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
284 },
285 ],
286 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the DomainMapping that
287 # was last processed by the controller.
288 #
289 # Clients polling for completed reconciliation should poll until
290 # observedGeneration = metadata.generation and the Ready condition&#x27;s status
291 # is True or False.
292 },
293 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
294 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
295 &quot;forceOverride&quot;: True or False, # If set, the mapping will override any mapping set before this spec was set.
296 # It is recommended that the user leaves this empty to receive an error
297 # warning about a potential conflict and only set it once the respective UI
298 # has given such a warning.
299 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to.
300 # The route must exist.
301 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
302 },
303}
304
305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
309
310Returns:
311 An object of the form:
312
313 { # Resource to hold the state and status of a user&#x27;s domain mapping.
314 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
315 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700316 # all objects users must create.
Bu Sun Kim65020912020-05-20 12:08:20 -0700317 &quot;annotations&quot;: { # Annotations is an unstructured key value map stored with a resource that
318 # may be set by external tools to store and retrieve arbitrary metadata. They
319 # are not queryable and should be preserved when modifying objects. More
320 # info: http://kubernetes.io/docs/user-guide/annotations +optional
321 &quot;a_key&quot;: &quot;A String&quot;,
322 },
323 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run.
324 #
325 # GenerateName is an optional prefix, used by the server, to generate a
326 # unique name ONLY IF the Name field has not been provided. If this field is
327 # used, the name returned to the client will be different than the name
328 # passed. This value will also be combined with a unique suffix. The provided
329 # value has the same validation rules as the Name field, and may be truncated
330 # by the length of the suffix required to make the value unique on the
331 # server.
332 #
333 # If this field is specified and the generated name exists, the server will
334 # NOT return a 409 - instead, it will either return 201 Created or 500 with
335 # Reason ServerTimeout indicating a unique name could not be found in the
336 # time allotted, and the client should retry (optionally after the time
337 # indicated in the Retry-After header).
338 #
339 # Applied only if Name is not specified.
340 # More info:
341 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700342 # +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700343 # string generateName = 2;
344 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700345 # Is required when creating
346 # resources, although some resources may allow a client to request the
347 # generation of an appropriate name automatically. Name is primarily intended
348 # for creation idempotence and configuration definition. Cannot be updated.
349 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
350 # +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700351 &quot;clusterName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run.
352 #
353 # The name of the cluster which the object belongs to.
354 # This is used to distinguish resources with same name and namespace in
355 # different clusters. This field is not set anywhere right now and apiserver
356 # is going to ignore it if set in create or update request. +optional
357 &quot;deletionGracePeriodSeconds&quot;: 42, # Not currently supported by Cloud Run.
358 #
359 # Number of seconds allowed for this object to gracefully terminate before
360 # it will be removed from the system. Only set when deletionTimestamp is also
361 # set. May only be shortened. Read-only. +optional
362 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run.
363 #
364 # Must be empty before the object is deleted from the registry. Each entry
365 # is an identifier for the responsible component that will remove the entry
366 # from the list. If the deletionTimestamp of the object is non-nil, entries
367 # in this list can only be removed.
368 # +optional
369 # +patchStrategy=merge
370 &quot;A String&quot;,
371 ],
372 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # DeletionTimestamp is RFC 3339 date and time at which this resource will be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700373 # deleted. This field is set by the server when a graceful deletion is
374 # requested by the user, and is not directly settable by a client. The
375 # resource is expected to be deleted (no longer visible from resource lists,
376 # and not reachable by name) after the time in this field, once the
377 # finalizers list is empty. As long as the finalizers list contains items,
378 # deletion is blocked. Once the deletionTimestamp is set, this value may not
379 # be unset or be set further into the future, although it may be shortened or
380 # the resource may be deleted prior to this time. For example, a user may
381 # request that a pod is deleted in 30 seconds. The Kubelet will react by
382 # sending a graceful termination signal to the containers in the pod. After
383 # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
384 # to the container and after cleanup, remove the pod from the API. In the
385 # presence of network partitions, this object may still exist after this
386 # timestamp, until an administrator or automated process can determine the
387 # resource is fully terminated.
388 # If not set, graceful deletion of the object has not been requested.
389 #
390 # Populated by the system when a graceful deletion is requested.
391 # Read-only.
392 # More info:
393 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
394 # +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700395 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have
396 # been deleted, this object will be garbage collected.
397 # +optional
398 { # OwnerReference contains enough information to let you identify an owning
399 # object. Currently, an owning object must be in the same namespace, so there
400 # is no namespace field.
401 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
402 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
403 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
404 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
405 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
406 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
407 # +optional
408 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
409 # More info:
410 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
411 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
412 # the owner cannot be deleted from the key-value store until this
413 # reference is removed.
414 # Defaults to false.
415 # To set this field, a user needs &quot;delete&quot; permission of the owner,
416 # otherwise 422 (Unprocessable Entity) will be returned.
417 # +optional
418 },
419 ],
420 &quot;creationTimestamp&quot;: &quot;A String&quot;, # CreationTimestamp is a timestamp representing the server time when this
421 # object was created. It is not guaranteed to be set in happens-before order
422 # across separate operations. Clients may not set this value. It is
423 # represented in RFC3339 form and is in UTC.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700424 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700425 # Populated by the system.
426 # Read-only.
427 # Null for lists.
428 # More info:
429 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
430 # +optional
431 &quot;labels&quot;: { # Map of string keys and values that can be used to organize and categorize
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700432 # (scope and select) objects. May match selectors of replication controllers
433 # and routes.
434 # More info: http://kubernetes.io/docs/user-guide/labels
435 # +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700436 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700437 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700438 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700439 # Populated by the system. Read-only.
440 # +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700441 &quot;resourceVersion&quot;: &quot;A String&quot;, # An opaque value that represents the internal version of this object that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700442 # can be used by clients to determine when objects have changed. May be used
443 # for optimistic concurrency, change detection, and the watch operation on a
444 # resource or set of resources. Clients must treat these values as opaque and
445 # passed unmodified back to the server. They may only be valid for a
446 # particular resource or set of resources.
447 #
448 # Populated by the system.
449 # Read-only.
450 # Value must be treated as opaque by clients and .
451 # More info:
452 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
453 # +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700454 &quot;uid&quot;: &quot;A String&quot;, # UID is the unique in time and space value for this object. It is typically
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700455 # generated by the server on successful creation of a resource and is not
456 # allowed to change on PUT operations.
457 #
458 # Populated by the system.
459 # Read-only.
460 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
461 # +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700462 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object.
463 # Populated by the system.
464 # Read-only.
465 # +optional
466 # string selfLink = 4;
467 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
468 # Cloud Run region. In Cloud Run the namespace must be equal to either the
469 # project ID or project number.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700470 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700471 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
472 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These
473 # records must be added to the domain&#x27;s DNS configuration in order to
474 # serve the application via this domain mapping.
475 { # A DNS resource record.
476 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for
477 # `CNAME` records. Example: &#x27;www&#x27;.
478 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
479 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035
480 # (section 5) and RFC 1034 (section 3.6.1).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700481 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700482 ],
483 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
484 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state
485 # of the DomainMapping.
486 { # DomainMappingCondition contains state information for a DomainMapping.
487 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status.
488 # +optional
489 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another.
490 # +optional
491 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
492 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info
493 # +optional
494 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status.
495 # +optional
496 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700497 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700498 ],
499 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the DomainMapping that
500 # was last processed by the controller.
501 #
502 # Clients polling for completed reconciliation should poll until
503 # observedGeneration = metadata.generation and the Ready condition&#x27;s status
504 # is True or False.
505 },
506 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
507 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
508 &quot;forceOverride&quot;: True or False, # If set, the mapping will override any mapping set before this spec was set.
509 # It is recommended that the user leaves this empty to receive an error
510 # warning about a potential conflict and only set it once the respective UI
511 # has given such a warning.
512 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to.
513 # The route must exist.
514 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
515 },
516 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700517</div>
518
519<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700520 <code class="details" id="delete">delete(name, orphanDependents=None, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700521 <pre>Rpc to delete a domain mapping.
522
523Args:
524 name: string, The name of the domain mapping being deleted. If needed, replace
525{namespace_id} with the project ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700526 orphanDependents: boolean, Deprecated.
527Specifies the cascade behavior on delete.
528Cloud Run only supports cascading behavior, so this must be false.
529This attribute is deprecated, and is now replaced with PropagationPolicy
530See https://github.com/kubernetes/kubernetes/issues/46659 for more info.
531 apiVersion: string, Cloud Run currently ignores this parameter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700532 propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores
533this setting, and deletes in the background. Please see
534kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for
535more information.
536 kind: string, Cloud Run currently ignores this parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700537 x__xgafv: string, V1 error format.
538 Allowed values
539 1 - v1 error format
540 2 - v2 error format
541
542Returns:
543 An object of the form:
544
545 { # A generic empty message that you can re-use to avoid defining duplicated
546 # empty messages in your APIs. A typical example is to use it as the request
547 # or the response type of an API method. For instance:
548 #
549 # service Foo {
550 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
551 # }
552 #
553 # The JSON representation for `Empty` is empty JSON object `{}`.
554 }</pre>
555</div>
556
557<div class="method">
558 <code class="details" id="get">get(name, x__xgafv=None)</code>
559 <pre>Rpc to get information about a domain mapping.
560
561Args:
562 name: string, The name of the domain mapping being retrieved. If needed, replace
563{namespace_id} with the project ID. (required)
564 x__xgafv: string, V1 error format.
565 Allowed values
566 1 - v1 error format
567 2 - v2 error format
568
569Returns:
570 An object of the form:
571
Bu Sun Kim65020912020-05-20 12:08:20 -0700572 { # Resource to hold the state and status of a user&#x27;s domain mapping.
573 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
574 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.
575 # all objects users must create.
576 &quot;annotations&quot;: { # Annotations is an unstructured key value map stored with a resource that
577 # may be set by external tools to store and retrieve arbitrary metadata. They
578 # are not queryable and should be preserved when modifying objects. More
579 # info: http://kubernetes.io/docs/user-guide/annotations +optional
580 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700581 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700582 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run.
583 #
584 # GenerateName is an optional prefix, used by the server, to generate a
585 # unique name ONLY IF the Name field has not been provided. If this field is
586 # used, the name returned to the client will be different than the name
587 # passed. This value will also be combined with a unique suffix. The provided
588 # value has the same validation rules as the Name field, and may be truncated
589 # by the length of the suffix required to make the value unique on the
590 # server.
591 #
592 # If this field is specified and the generated name exists, the server will
593 # NOT return a 409 - instead, it will either return 201 Created or 500 with
594 # Reason ServerTimeout indicating a unique name could not be found in the
595 # time allotted, and the client should retry (optionally after the time
596 # indicated in the Retry-After header).
597 #
598 # Applied only if Name is not specified.
599 # More info:
600 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
601 # +optional
602 # string generateName = 2;
603 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
604 # Is required when creating
605 # resources, although some resources may allow a client to request the
606 # generation of an appropriate name automatically. Name is primarily intended
607 # for creation idempotence and configuration definition. Cannot be updated.
608 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
609 # +optional
610 &quot;clusterName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run.
611 #
612 # The name of the cluster which the object belongs to.
613 # This is used to distinguish resources with same name and namespace in
614 # different clusters. This field is not set anywhere right now and apiserver
615 # is going to ignore it if set in create or update request. +optional
616 &quot;deletionGracePeriodSeconds&quot;: 42, # Not currently supported by Cloud Run.
617 #
618 # Number of seconds allowed for this object to gracefully terminate before
619 # it will be removed from the system. Only set when deletionTimestamp is also
620 # set. May only be shortened. Read-only. +optional
621 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run.
622 #
623 # Must be empty before the object is deleted from the registry. Each entry
624 # is an identifier for the responsible component that will remove the entry
625 # from the list. If the deletionTimestamp of the object is non-nil, entries
626 # in this list can only be removed.
627 # +optional
628 # +patchStrategy=merge
629 &quot;A String&quot;,
630 ],
631 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # DeletionTimestamp is RFC 3339 date and time at which this resource will be
632 # deleted. This field is set by the server when a graceful deletion is
633 # requested by the user, and is not directly settable by a client. The
634 # resource is expected to be deleted (no longer visible from resource lists,
635 # and not reachable by name) after the time in this field, once the
636 # finalizers list is empty. As long as the finalizers list contains items,
637 # deletion is blocked. Once the deletionTimestamp is set, this value may not
638 # be unset or be set further into the future, although it may be shortened or
639 # the resource may be deleted prior to this time. For example, a user may
640 # request that a pod is deleted in 30 seconds. The Kubelet will react by
641 # sending a graceful termination signal to the containers in the pod. After
642 # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
643 # to the container and after cleanup, remove the pod from the API. In the
644 # presence of network partitions, this object may still exist after this
645 # timestamp, until an administrator or automated process can determine the
646 # resource is fully terminated.
647 # If not set, graceful deletion of the object has not been requested.
648 #
649 # Populated by the system when a graceful deletion is requested.
650 # Read-only.
651 # More info:
652 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
653 # +optional
654 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have
655 # been deleted, this object will be garbage collected.
656 # +optional
657 { # OwnerReference contains enough information to let you identify an owning
658 # object. Currently, an owning object must be in the same namespace, so there
659 # is no namespace field.
660 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
661 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
662 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
663 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
664 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
665 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
666 # +optional
667 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
668 # More info:
669 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
670 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
671 # the owner cannot be deleted from the key-value store until this
672 # reference is removed.
673 # Defaults to false.
674 # To set this field, a user needs &quot;delete&quot; permission of the owner,
675 # otherwise 422 (Unprocessable Entity) will be returned.
676 # +optional
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700677 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700678 ],
679 &quot;creationTimestamp&quot;: &quot;A String&quot;, # CreationTimestamp is a timestamp representing the server time when this
680 # object was created. It is not guaranteed to be set in happens-before order
681 # across separate operations. Clients may not set this value. It is
682 # represented in RFC3339 form and is in UTC.
683 #
684 # Populated by the system.
685 # Read-only.
686 # Null for lists.
687 # More info:
688 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
689 # +optional
690 &quot;labels&quot;: { # Map of string keys and values that can be used to organize and categorize
691 # (scope and select) objects. May match selectors of replication controllers
692 # and routes.
693 # More info: http://kubernetes.io/docs/user-guide/labels
694 # +optional
695 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700696 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700697 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state.
698 # Populated by the system. Read-only.
699 # +optional
700 &quot;resourceVersion&quot;: &quot;A String&quot;, # An opaque value that represents the internal version of this object that
701 # can be used by clients to determine when objects have changed. May be used
702 # for optimistic concurrency, change detection, and the watch operation on a
703 # resource or set of resources. Clients must treat these values as opaque and
704 # passed unmodified back to the server. They may only be valid for a
705 # particular resource or set of resources.
706 #
707 # Populated by the system.
708 # Read-only.
709 # Value must be treated as opaque by clients and .
710 # More info:
711 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
712 # +optional
713 &quot;uid&quot;: &quot;A String&quot;, # UID is the unique in time and space value for this object. It is typically
714 # generated by the server on successful creation of a resource and is not
715 # allowed to change on PUT operations.
716 #
717 # Populated by the system.
718 # Read-only.
719 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
720 # +optional
721 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object.
722 # Populated by the system.
723 # Read-only.
724 # +optional
725 # string selfLink = 4;
726 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
727 # Cloud Run region. In Cloud Run the namespace must be equal to either the
728 # project ID or project number.
729 },
730 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
731 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These
732 # records must be added to the domain&#x27;s DNS configuration in order to
733 # serve the application via this domain mapping.
734 { # A DNS resource record.
735 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for
736 # `CNAME` records. Example: &#x27;www&#x27;.
737 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
738 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035
739 # (section 5) and RFC 1034 (section 3.6.1).
740 },
741 ],
742 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
743 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state
744 # of the DomainMapping.
745 { # DomainMappingCondition contains state information for a DomainMapping.
746 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status.
747 # +optional
748 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another.
749 # +optional
750 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
751 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info
752 # +optional
753 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status.
754 # +optional
755 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
756 },
757 ],
758 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the DomainMapping that
759 # was last processed by the controller.
760 #
761 # Clients polling for completed reconciliation should poll until
762 # observedGeneration = metadata.generation and the Ready condition&#x27;s status
763 # is True or False.
764 },
765 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
766 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
767 &quot;forceOverride&quot;: True or False, # If set, the mapping will override any mapping set before this spec was set.
768 # It is recommended that the user leaves this empty to receive an error
769 # warning about a potential conflict and only set it once the respective UI
770 # has given such a warning.
771 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to.
772 # The route must exist.
773 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
774 },
775 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700776</div>
777
778<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700779 <code class="details" id="list">list(parent, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700780 <pre>Rpc to list domain mappings.
781
782Args:
783 parent: string, The project ID or project number from which the domain mappings should be
784listed. (required)
785 labelSelector: string, Allows to filter resources based on a label. Supported operations are
786=, !=, exists, in, and notIn.
Bu Sun Kim65020912020-05-20 12:08:20 -0700787 resourceVersion: string, The baseline resource version from which the list or watch operation should
788start. Not currently used by Cloud Run.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700789 includeUninitialized: boolean, Not currently used by Cloud Run.
Bu Sun Kim65020912020-05-20 12:08:20 -0700790 fieldSelector: string, Allows to filter resources based on a specific value for a field name.
791Send this in a query string format. i.e. &#x27;metadata.name%3Dlorem&#x27;.
792Not currently used by Cloud Run.
793 continue: string, Optional encoded string to continue paging.
794 limit: integer, The maximum number of records that should be returned.
795 watch: boolean, Flag that indicates that the client expects to watch this resource as well.
796Not currently used by Cloud Run.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700797 x__xgafv: string, V1 error format.
798 Allowed values
799 1 - v1 error format
800 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700801
802Returns:
803 An object of the form:
804
805 { # ListDomainMappingsResponse is a list of DomainMapping resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700806 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
807 &quot;kind&quot;: &quot;A String&quot;, # The kind of this resource, in this case &quot;DomainMappingList&quot;.
808 &quot;unreachable&quot;: [ # Locations that could not be reached.
809 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700810 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700811 &quot;metadata&quot;: { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this DomainMapping list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700812 # lists and various status objects. A resource may have only one of
813 # {ObjectMeta, ListMeta}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700814 &quot;resourceVersion&quot;: &quot;A String&quot;, # String that identifies the server&#x27;s internal version of this object that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700815 # can be used by clients to determine when objects have changed. Value must
816 # be treated as opaque by clients and passed unmodified back to the server.
817 # Populated by the system.
818 # Read-only.
819 # More info:
820 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
821 # +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700822 &quot;continue&quot;: &quot;A String&quot;, # continue may be set if the user set a limit on the number of items
823 # returned, and indicates that the server has more data available. The value
824 # is opaque and may be used to issue another request to the endpoint that
825 # served this list to retrieve the next set of available objects. Continuing
826 # a list may not be possible if the server configuration has changed or more
827 # than a few minutes have passed. The resourceVersion field returned when
828 # using this continue value will be identical to the value in the first
829 # response.
830 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object.
831 # Populated by the system.
832 # Read-only.
833 # +optional
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700834 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700835 &quot;items&quot;: [ # List of DomainMappings.
836 { # Resource to hold the state and status of a user&#x27;s domain mapping.
837 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
838 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.
839 # all objects users must create.
840 &quot;annotations&quot;: { # Annotations is an unstructured key value map stored with a resource that
841 # may be set by external tools to store and retrieve arbitrary metadata. They
842 # are not queryable and should be preserved when modifying objects. More
843 # info: http://kubernetes.io/docs/user-guide/annotations +optional
844 &quot;a_key&quot;: &quot;A String&quot;,
845 },
846 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run.
847 #
848 # GenerateName is an optional prefix, used by the server, to generate a
849 # unique name ONLY IF the Name field has not been provided. If this field is
850 # used, the name returned to the client will be different than the name
851 # passed. This value will also be combined with a unique suffix. The provided
852 # value has the same validation rules as the Name field, and may be truncated
853 # by the length of the suffix required to make the value unique on the
854 # server.
855 #
856 # If this field is specified and the generated name exists, the server will
857 # NOT return a 409 - instead, it will either return 201 Created or 500 with
858 # Reason ServerTimeout indicating a unique name could not be found in the
859 # time allotted, and the client should retry (optionally after the time
860 # indicated in the Retry-After header).
861 #
862 # Applied only if Name is not specified.
863 # More info:
864 # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
865 # +optional
866 # string generateName = 2;
867 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region.
868 # Is required when creating
869 # resources, although some resources may allow a client to request the
870 # generation of an appropriate name automatically. Name is primarily intended
871 # for creation idempotence and configuration definition. Cannot be updated.
872 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
873 # +optional
874 &quot;clusterName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run.
875 #
876 # The name of the cluster which the object belongs to.
877 # This is used to distinguish resources with same name and namespace in
878 # different clusters. This field is not set anywhere right now and apiserver
879 # is going to ignore it if set in create or update request. +optional
880 &quot;deletionGracePeriodSeconds&quot;: 42, # Not currently supported by Cloud Run.
881 #
882 # Number of seconds allowed for this object to gracefully terminate before
883 # it will be removed from the system. Only set when deletionTimestamp is also
884 # set. May only be shortened. Read-only. +optional
885 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run.
886 #
887 # Must be empty before the object is deleted from the registry. Each entry
888 # is an identifier for the responsible component that will remove the entry
889 # from the list. If the deletionTimestamp of the object is non-nil, entries
890 # in this list can only be removed.
891 # +optional
892 # +patchStrategy=merge
893 &quot;A String&quot;,
894 ],
895 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # 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 # +optional
918 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have
919 # been deleted, this object will be garbage collected.
920 # +optional
921 { # OwnerReference contains enough information to let you identify an owning
922 # object. Currently, an owning object must be in the same namespace, so there
923 # is no namespace field.
924 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
925 &quot;name&quot;: &quot;A String&quot;, # Name of the referent.
926 # More info: http://kubernetes.io/docs/user-guide/identifiers#names
927 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent.
928 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
929 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller.
930 # +optional
931 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent.
932 # More info:
933 # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
934 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then
935 # the owner cannot be deleted from the key-value store until this
936 # reference is removed.
937 # Defaults to false.
938 # To set this field, a user needs &quot;delete&quot; permission of the owner,
939 # otherwise 422 (Unprocessable Entity) will be returned.
940 # +optional
941 },
942 ],
943 &quot;creationTimestamp&quot;: &quot;A String&quot;, # CreationTimestamp is a timestamp representing the server time when this
944 # object was created. It is not guaranteed to be set in happens-before order
945 # across separate operations. Clients may not set this value. It is
946 # represented in RFC3339 form and is in UTC.
947 #
948 # Populated by the system.
949 # Read-only.
950 # Null for lists.
951 # More info:
952 # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
953 # +optional
954 &quot;labels&quot;: { # Map of string keys and values that can be used to organize and categorize
955 # (scope and select) objects. May match selectors of replication controllers
956 # and routes.
957 # More info: http://kubernetes.io/docs/user-guide/labels
958 # +optional
959 &quot;a_key&quot;: &quot;A String&quot;,
960 },
961 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state.
962 # Populated by the system. Read-only.
963 # +optional
964 &quot;resourceVersion&quot;: &quot;A String&quot;, # An opaque value that represents the internal version of this object that
965 # can be used by clients to determine when objects have changed. May be used
966 # for optimistic concurrency, change detection, and the watch operation on a
967 # resource or set of resources. Clients must treat these values as opaque and
968 # passed unmodified back to the server. They may only be valid for a
969 # particular resource or set of resources.
970 #
971 # Populated by the system.
972 # Read-only.
973 # Value must be treated as opaque by clients and .
974 # More info:
975 # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
976 # +optional
977 &quot;uid&quot;: &quot;A String&quot;, # UID is the unique in time and space value for this object. It is typically
978 # generated by the server on successful creation of a resource and is not
979 # allowed to change on PUT operations.
980 #
981 # Populated by the system.
982 # Read-only.
983 # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
984 # +optional
985 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object.
986 # Populated by the system.
987 # Read-only.
988 # +optional
989 # string selfLink = 4;
990 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a
991 # Cloud Run region. In Cloud Run the namespace must be equal to either the
992 # project ID or project number.
993 },
994 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
995 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These
996 # records must be added to the domain&#x27;s DNS configuration in order to
997 # serve the application via this domain mapping.
998 { # A DNS resource record.
999 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for
1000 # `CNAME` records. Example: &#x27;www&#x27;.
1001 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
1002 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035
1003 # (section 5) and RFC 1034 (section 3.6.1).
1004 },
1005 ],
1006 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
1007 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state
1008 # of the DomainMapping.
1009 { # DomainMappingCondition contains state information for a DomainMapping.
1010 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status.
1011 # +optional
1012 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another.
1013 # +optional
1014 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
1015 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info
1016 # +optional
1017 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status.
1018 # +optional
1019 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
1020 },
1021 ],
1022 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the DomainMapping that
1023 # was last processed by the controller.
1024 #
1025 # Clients polling for completed reconciliation should poll until
1026 # observedGeneration = metadata.generation and the Ready condition&#x27;s status
1027 # is True or False.
1028 },
1029 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
1030 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
1031 &quot;forceOverride&quot;: True or False, # If set, the mapping will override any mapping set before this spec was set.
1032 # It is recommended that the user leaves this empty to receive an error
1033 # warning about a potential conflict and only set it once the respective UI
1034 # has given such a warning.
1035 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to.
1036 # The route must exist.
1037 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
1038 },
1039 },
1040 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001041 }</pre>
1042</div>
1043
1044</body></html>