blob: 2c334f9c84dbe22c9bd09d1bf78e84d850722101 [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
Bu Sun Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="run_v1alpha1.html">Cloud Run Admin API</a> . <a href="run_v1alpha1.namespaces.html">namespaces</a> . <a href="run_v1alpha1.namespaces.domainmappings.html">domainmappings</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Creates a new domain mapping.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <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 -070085<p class="firstline">Rpc to delete a domain mapping.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Rpc to get information about a domain mapping.</p>
89<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090 <code><a href="#list">list(parent, fieldSelector=None, limit=None, watch=None, continue=None, includeUninitialized=None, labelSelector=None, resourceVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Rpc to list domain mappings.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100 <pre>Creates a new domain mapping.
101
102Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700103 parent: string, The project ID or project number in which this domain mapping should be created. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700105 The object takes the form of:
106
Bu Sun Kim65020912020-05-20 12:08:20 -0700107{ # Resource to hold the state and status of a user&#x27;s domain mapping.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
109 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
110 &quot;forceOverride&quot;: True or False, # If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
111 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to. The route must exist.
112 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700113 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition&#x27;s status is True or False.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700115 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
116 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
117 { # DomainMappingCondition contains state information for a DomainMapping.
118 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
119 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status. +optional
120 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
121 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info +optional
122 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status. +optional
123 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another. +optional
124 },
125 ],
126 &quot;url&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported Holds the URL that will serve the traffic of the DomainMapping. +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700127 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These records must be added to the domain&#x27;s DNS configuration in order to serve the application via this domain mapping.
128 { # A DNS resource record.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700129 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700130 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700131 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: &#x27;www&#x27;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700132 },
133 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700134 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700135 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700136 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700137 &quot;annotations&quot;: { # Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700138 &quot;a_key&quot;: &quot;A String&quot;,
139 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700140 &quot;creationTimestamp&quot;: &quot;A String&quot;, # CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141 &quot;deletionGracePeriodSeconds&quot;: 42, # Not currently supported by Cloud Run. Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional
142 &quot;resourceVersion&quot;: &quot;A String&quot;, # An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700143 &quot;uid&quot;: &quot;A String&quot;, # UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700144 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency +optional string generateName = 2;
145 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge
146 &quot;A String&quot;,
147 ],
148 &quot;clusterName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional
149 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
150 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional
151 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional
152 { # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
153 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
154 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
155 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
156 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
157 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs &quot;delete&quot; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
158 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
159 },
160 ],
161 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.
162 &quot;labels&quot;: { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels +optional
163 &quot;a_key&quot;: &quot;A String&quot;,
164 },
165 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700166 },
167 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700168 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700169}
170
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176Returns:
177 An object of the form:
178
179 { # Resource to hold the state and status of a user&#x27;s domain mapping.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700180 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
181 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
182 &quot;forceOverride&quot;: True or False, # If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
183 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to. The route must exist.
184 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700185 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700186 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition&#x27;s status is True or False.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700187 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
188 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
189 { # DomainMappingCondition contains state information for a DomainMapping.
190 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
191 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status. +optional
192 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
193 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info +optional
194 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status. +optional
195 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another. +optional
196 },
197 ],
198 &quot;url&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported Holds the URL that will serve the traffic of the DomainMapping. +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700199 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These records must be added to the domain&#x27;s DNS configuration in order to serve the application via this domain mapping.
200 { # A DNS resource record.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700201 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700202 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700203 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: &#x27;www&#x27;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700204 },
205 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700206 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700207 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700208 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700209 &quot;annotations&quot;: { # Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700210 &quot;a_key&quot;: &quot;A String&quot;,
211 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700212 &quot;creationTimestamp&quot;: &quot;A String&quot;, # CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700213 &quot;deletionGracePeriodSeconds&quot;: 42, # Not currently supported by Cloud Run. Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional
214 &quot;resourceVersion&quot;: &quot;A String&quot;, # An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700215 &quot;uid&quot;: &quot;A String&quot;, # UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700216 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency +optional string generateName = 2;
217 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge
218 &quot;A String&quot;,
219 ],
220 &quot;clusterName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional
221 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
222 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional
223 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional
224 { # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
225 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
226 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
227 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
228 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
229 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs &quot;delete&quot; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
230 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
231 },
232 ],
233 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.
234 &quot;labels&quot;: { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels +optional
235 &quot;a_key&quot;: &quot;A String&quot;,
236 },
237 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700238 },
239 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700240 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700241 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700242</div>
243
244<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700245 <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 -0700246 <pre>Rpc to delete a domain mapping.
247
248Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700249 name: string, The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700250 orphanDependents: boolean, Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700251 apiVersion: string, Cloud Run currently ignores this parameter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700252 propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700253 kind: string, Cloud Run currently ignores this parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259Returns:
260 An object of the form:
261
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700262 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="get">get(name, x__xgafv=None)</code>
268 <pre>Rpc to get information about a domain mapping.
269
270Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700271 name: string, The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700272 x__xgafv: string, V1 error format.
273 Allowed values
274 1 - v1 error format
275 2 - v2 error format
276
277Returns:
278 An object of the form:
279
Bu Sun Kim65020912020-05-20 12:08:20 -0700280 { # Resource to hold the state and status of a user&#x27;s domain mapping.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700281 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
282 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
283 &quot;forceOverride&quot;: True or False, # If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
284 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to. The route must exist.
285 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700286 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700287 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition&#x27;s status is True or False.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700288 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
289 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
290 { # DomainMappingCondition contains state information for a DomainMapping.
291 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
292 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status. +optional
293 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
294 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info +optional
295 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status. +optional
296 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another. +optional
297 },
298 ],
299 &quot;url&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported Holds the URL that will serve the traffic of the DomainMapping. +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700300 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These records must be added to the domain&#x27;s DNS configuration in order to serve the application via this domain mapping.
301 { # A DNS resource record.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700302 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700303 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700304 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: &#x27;www&#x27;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700305 },
306 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700307 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700308 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700309 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700310 &quot;annotations&quot;: { # Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700311 &quot;a_key&quot;: &quot;A String&quot;,
312 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700313 &quot;creationTimestamp&quot;: &quot;A String&quot;, # CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700314 &quot;deletionGracePeriodSeconds&quot;: 42, # Not currently supported by Cloud Run. Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional
315 &quot;resourceVersion&quot;: &quot;A String&quot;, # An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700316 &quot;uid&quot;: &quot;A String&quot;, # UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700317 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency +optional string generateName = 2;
318 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge
319 &quot;A String&quot;,
320 ],
321 &quot;clusterName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional
322 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
323 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional
324 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional
325 { # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
326 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
327 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
328 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
329 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
330 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs &quot;delete&quot; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
331 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
332 },
333 ],
334 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.
335 &quot;labels&quot;: { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels +optional
336 &quot;a_key&quot;: &quot;A String&quot;,
337 },
338 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700339 },
340 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700341 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700342 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700343</div>
344
345<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700346 <code class="details" id="list">list(parent, fieldSelector=None, limit=None, watch=None, continue=None, includeUninitialized=None, labelSelector=None, resourceVersion=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700347 <pre>Rpc to list domain mappings.
348
349Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700350 parent: string, The project ID or project number from which the domain mappings should be listed. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700351 fieldSelector: string, Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. &#x27;metadata.name%3Dlorem&#x27;. Not currently used by Cloud Run.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700352 limit: integer, The maximum number of records that should be returned.
353 watch: boolean, Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700354 continue: string, Optional encoded string to continue paging.
355 includeUninitialized: boolean, Not currently used by Cloud Run.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700356 labelSelector: string, Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.
357 resourceVersion: string, The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358 x__xgafv: string, V1 error format.
359 Allowed values
360 1 - v1 error format
361 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700362
363Returns:
364 An object of the form:
365
366 { # ListDomainMappingsResponse is a list of DomainMapping resources.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700367 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700368 &quot;items&quot;: [ # List of DomainMappings.
369 { # Resource to hold the state and status of a user&#x27;s domain mapping.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700370 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
371 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
372 &quot;forceOverride&quot;: True or False, # If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
373 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to. The route must exist.
374 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700375 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700376 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition&#x27;s status is True or False.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700377 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
378 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
379 { # DomainMappingCondition contains state information for a DomainMapping.
380 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
381 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status. +optional
382 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
383 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info +optional
384 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status. +optional
385 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another. +optional
386 },
387 ],
388 &quot;url&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported Holds the URL that will serve the traffic of the DomainMapping. +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700389 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These records must be added to the domain&#x27;s DNS configuration in order to serve the application via this domain mapping.
390 { # A DNS resource record.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700391 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700392 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700393 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: &#x27;www&#x27;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700394 },
395 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700396 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700397 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700398 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700399 &quot;annotations&quot;: { # Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700400 &quot;a_key&quot;: &quot;A String&quot;,
401 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700402 &quot;creationTimestamp&quot;: &quot;A String&quot;, # CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700403 &quot;deletionGracePeriodSeconds&quot;: 42, # Not currently supported by Cloud Run. Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional
404 &quot;resourceVersion&quot;: &quot;A String&quot;, # An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700405 &quot;uid&quot;: &quot;A String&quot;, # UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700406 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency +optional string generateName = 2;
407 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge
408 &quot;A String&quot;,
409 ],
410 &quot;clusterName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional
411 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
412 &quot;name&quot;: &quot;A String&quot;, # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional
413 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional
414 { # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
415 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
416 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
417 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
418 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
419 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs &quot;delete&quot; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
420 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
421 },
422 ],
423 &quot;namespace&quot;: &quot;A String&quot;, # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.
424 &quot;labels&quot;: { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels +optional
425 &quot;a_key&quot;: &quot;A String&quot;,
426 },
427 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700428 },
429 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700430 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700431 },
432 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700433 &quot;kind&quot;: &quot;A String&quot;, # The kind of this resource, in this case &quot;DomainMappingList&quot;.
434 &quot;metadata&quot;: { # ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. # Metadata associated with this DomainMapping list.
435 &quot;continue&quot;: &quot;A String&quot;, # continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.
436 &quot;resourceVersion&quot;: &quot;A String&quot;, # String that identifies the server&#x27;s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional
437 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional
438 },
439 &quot;unreachable&quot;: [ # Locations that could not be reached.
440 &quot;A String&quot;,
441 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700442 }</pre>
443</div>
444
445</body></html>