blob: 788b33fffd3bffad6f0e1fb34e4a55a26c06aa6b [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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080084 <code><a href="#delete">delete(name, orphanDependents=None, propagationPolicy=None, kind=None, apiVersion=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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080090 <code><a href="#list">list(parent, limit=None, resourceVersion=None, watch=None, labelSelector=None, continue=None, fieldSelector=None, includeUninitialized=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
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800107{ # Resource to hold the state and status of a user&#x27;s domain mapping. NOTE: This resource is currently in Beta.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800108 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800109 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800110 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800111 &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.
112 { # A DNS resource record.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800113 &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;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800114 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800115 &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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800116 },
117 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800118 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
119 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800120 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
121 { # DomainMappingCondition contains state information for a DomainMapping.
122 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
123 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status. +optional
124 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
125 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info +optional
126 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another. +optional
127 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status. +optional
128 },
129 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800130 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800131 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
132 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
133 &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.
134 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to. The route must exist.
135 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
136 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800137 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800138 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800139 &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
140 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800141 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800142 &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
143 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800144 &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
145 { # 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800146 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800147 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800148 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800149 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
150 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800151 &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
152 },
153 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800154 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
155 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800156 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800157 &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
158 &quot;a_key&quot;: &quot;A String&quot;,
159 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800160 &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;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800161 &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
162 &quot;a_key&quot;: &quot;A String&quot;,
163 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800164 &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
165 &quot;A String&quot;,
166 ],
167 &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
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800168 },
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
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800179 { # Resource to hold the state and status of a user&#x27;s domain mapping. NOTE: This resource is currently in Beta.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800180 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800181 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800182 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800183 &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.
184 { # A DNS resource record.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800185 &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;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800186 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800187 &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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800188 },
189 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800190 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
191 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800192 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
193 { # DomainMappingCondition contains state information for a DomainMapping.
194 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
195 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status. +optional
196 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
197 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info +optional
198 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another. +optional
199 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status. +optional
200 },
201 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800202 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800203 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
204 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
205 &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.
206 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to. The route must exist.
207 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
208 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800209 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800210 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800211 &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
212 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800213 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800214 &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
215 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800216 &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
217 { # 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800218 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800219 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800220 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800221 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
222 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800223 &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
224 },
225 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800226 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
227 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800228 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800229 &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
230 &quot;a_key&quot;: &quot;A String&quot;,
231 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800232 &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;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800233 &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
234 &quot;a_key&quot;: &quot;A String&quot;,
235 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800236 &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
237 &quot;A String&quot;,
238 ],
239 &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
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800240 },
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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800245 <code class="details" id="delete">delete(name, orphanDependents=None, propagationPolicy=None, kind=None, apiVersion=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)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800250 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800251 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.
252 kind: string, Cloud Run currently ignores this parameter.
253 apiVersion: 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
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800280 { # Resource to hold the state and status of a user&#x27;s domain mapping. NOTE: This resource is currently in Beta.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800281 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800282 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800283 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800284 &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.
285 { # A DNS resource record.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800286 &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;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800287 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800288 &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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800289 },
290 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800291 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
292 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800293 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
294 { # DomainMappingCondition contains state information for a DomainMapping.
295 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
296 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status. +optional
297 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
298 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info +optional
299 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another. +optional
300 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status. +optional
301 },
302 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800303 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800304 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
305 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
306 &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.
307 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to. The route must exist.
308 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
309 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800310 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800311 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800312 &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
313 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800314 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800315 &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
316 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800317 &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
318 { # 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800319 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800320 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800321 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800322 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
323 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800324 &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
325 },
326 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800327 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
328 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800329 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800330 &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
331 &quot;a_key&quot;: &quot;A String&quot;,
332 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800333 &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;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800334 &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
335 &quot;a_key&quot;: &quot;A String&quot;,
336 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800337 &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
338 &quot;A String&quot;,
339 ],
340 &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
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800341 },
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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800346 <code class="details" id="list">list(parent, limit=None, resourceVersion=None, watch=None, labelSelector=None, continue=None, fieldSelector=None, includeUninitialized=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)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800351 limit: integer, The maximum number of records that should be returned.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800352 resourceVersion: string, The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.
353 watch: boolean, Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.
354 labelSelector: string, Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.
355 continue: string, Optional encoded string to continue paging.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800356 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800357 includeUninitialized: boolean, 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800367 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
368 &quot;kind&quot;: &quot;A String&quot;, # The kind of this resource, in this case &quot;DomainMappingList&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800369 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800370 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800371 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800372 &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.
373 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700374 &quot;items&quot;: [ # List of DomainMappings.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800375 { # Resource to hold the state and status of a user&#x27;s domain mapping. NOTE: This resource is currently in Beta.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800376 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;DomainMapping&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800377 &quot;status&quot;: { # The current state of the Domain Mapping. # The current status of the DomainMapping.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800378 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800379 &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.
380 { # A DNS resource record.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800381 &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;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800382 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: `AAAA`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800383 &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).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800384 },
385 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800386 &quot;mappedRouteName&quot;: &quot;A String&quot;, # The name of the route that the mapping currently points to.
387 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800388 &quot;conditions&quot;: [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
389 { # DomainMappingCondition contains state information for a DomainMapping.
390 &quot;type&quot;: &quot;A String&quot;, # Type of domain mapping condition.
391 &quot;reason&quot;: &quot;A String&quot;, # One-word CamelCase reason for the condition&#x27;s current status. +optional
392 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
393 &quot;severity&quot;: &quot;A String&quot;, # How to interpret failures of this condition, one of Error, Warning, Info +optional
394 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Last time the condition transitioned from one status to another. +optional
395 &quot;message&quot;: &quot;A String&quot;, # Human readable message indicating details about the current status. +optional
396 },
397 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800398 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800399 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;domains.cloudrun.com/v1alpha1&quot;.
400 &quot;spec&quot;: { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
401 &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.
402 &quot;routeName&quot;: &quot;A String&quot;, # The name of the Knative Route that this DomainMapping applies to. The route must exist.
403 &quot;certificateMode&quot;: &quot;A String&quot;, # The mode of the certificate.
404 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800405 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800406 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800407 &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
408 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800409 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800410 &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
411 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800412 &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
413 { # 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800414 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800415 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800416 &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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800417 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
418 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800419 &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
420 },
421 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800422 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800424 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800425 &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
426 &quot;a_key&quot;: &quot;A String&quot;,
427 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800428 &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;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800429 &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
430 &quot;a_key&quot;: &quot;A String&quot;,
431 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800432 &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
433 &quot;A String&quot;,
434 ],
435 &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
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800436 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700437 },
438 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800439 &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>