| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="run_v1.html">Cloud Run API</a> . <a href="run_v1.namespaces.html">namespaces</a> . <a href="run_v1.namespaces.domainmappings.html">domainmappings</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Create a new domain mapping.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(name, propagationPolicy=None, kind=None, apiVersion=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <p class="firstline">Delete a domain mapping.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Get information about a domain mapping.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 88 | <p class="firstline">List domain mappings.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 92 | <pre>Create a new domain mapping. |
| 93 | |
| 94 | Args: |
| 95 | parent: string, The namespace in which the domain mapping should be created. |
| 96 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 97 | or number. (required) |
| 98 | body: object, The request body. |
| 99 | The object takes the form of: |
| 100 | |
| 101 | { # Resource to hold the state and status of a user's domain mapping. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 102 | "status": { # The current state of the Domain Mapping. # The current status of the DomainMapping. |
| 103 | "mappedRouteName": "A String", # The name of the route that the mapping currently points to. |
| 104 | "conditions": [ # Array of observed DomainMappingConditions, indicating the current state |
| 105 | # of the DomainMapping. |
| 106 | { # Condition defines a generic condition for a Resource |
| 107 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 108 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 109 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 110 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 111 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 112 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 113 | # See also: |
| 114 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 115 | # Types common to all resources include: |
| 116 | # * "Ready": True when the Resource is ready. |
| 117 | }, |
| 118 | ], |
| 119 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that |
| 120 | # was last processed by the controller. |
| 121 | # |
| 122 | # Clients polling for completed reconciliation should poll until |
| 123 | # observedGeneration = metadata.generation and the Ready condition's status |
| 124 | # is True or False. |
| 125 | "resourceRecords": [ # The resource records required to configure this domain mapping. These |
| 126 | # records must be added to the domain's DNS configuration in order to |
| 127 | # serve the application via this domain mapping. |
| 128 | { # A DNS resource record. |
| 129 | "name": "A String", # Relative name of the object affected by this record. Only applicable for |
| 130 | # `CNAME` records. Example: 'www'. |
| 131 | "type": "A String", # Resource record type. Example: `AAAA`. |
| 132 | "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 |
| 133 | # (section 5) and RFC 1034 (section 3.6.1). |
| 134 | }, |
| 135 | ], |
| 136 | }, |
| 137 | "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". |
| 138 | "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping. |
| 139 | "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set. |
| 140 | # It is recommended that the user leaves this empty to receive an error |
| 141 | # warning about a potential conflict and only set it once the respective UI |
| 142 | # has given such a warning. |
| 143 | "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to. |
| 144 | # The route must exist. |
| 145 | "certificateMode": "A String", # The mode of the certificate. |
| 146 | }, |
| 147 | "kind": "A String", # The kind of resource, in this case "DomainMapping". |
| 148 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate. |
| 149 | # persisted resources must have, which includes all objects users must create. |
| 150 | "annotations": { # (Optional) |
| 151 | # |
| 152 | # Annotations is an unstructured key value map stored with a resource that |
| 153 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 154 | # are not queryable and should be preserved when modifying objects. More |
| 155 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 156 | "a_key": "A String", |
| 157 | }, |
| 158 | "generateName": "A String", # (Optional) |
| 159 | # |
| 160 | # Cloud Run fully managed: not supported |
| 161 | # |
| 162 | # Cloud Run for Anthos: supported |
| 163 | # |
| 164 | # GenerateName is an optional prefix, used by the server, to generate a |
| 165 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 166 | # used, the name returned to the client will be different than the name |
| 167 | # passed. This value will also be combined with a unique suffix. The provided |
| 168 | # value has the same validation rules as the Name field, and may be truncated |
| 169 | # by the length of the suffix required to make the value unique on the |
| 170 | # server. |
| 171 | # |
| 172 | # If this field is specified and the generated name exists, the server will |
| 173 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 174 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 175 | # time allotted, and the client should retry (optionally after the time |
| 176 | # indicated in the Retry-After header). |
| 177 | # |
| 178 | # Applied only if Name is not specified. |
| 179 | # More info: |
| 180 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 181 | # string generateName = 2; |
| 182 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 183 | # Is required when creating |
| 184 | # resources, although some resources may allow a client to request the |
| 185 | # generation of an appropriate name automatically. Name is primarily intended |
| 186 | # for creation idempotence and configuration definition. Cannot be updated. |
| 187 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 188 | # +optional |
| 189 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 190 | # |
| 191 | # Cloud Run fully managed: not supported |
| 192 | # |
| 193 | # Cloud Run for Anthos: supported |
| 194 | # |
| 195 | # Number of seconds allowed for this object to gracefully terminate before |
| 196 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 197 | # set. May only be shortened. Read-only. |
| 198 | "clusterName": "A String", # (Optional) |
| 199 | # |
| 200 | # Cloud Run fully managed: not supported |
| 201 | # |
| 202 | # Cloud Run for Anthos: supported |
| 203 | # |
| 204 | # The name of the cluster which the object belongs to. |
| 205 | # This is used to distinguish resources with same name and namespace in |
| 206 | # different clusters. This field is not set anywhere right now and apiserver |
| 207 | # is going to ignore it if set in create or update request. |
| 208 | "finalizers": [ # (Optional) |
| 209 | # |
| 210 | # Cloud Run fully managed: not supported |
| 211 | # |
| 212 | # Cloud Run for Anthos: supported |
| 213 | # |
| 214 | # Must be empty before the object is deleted from the registry. Each entry |
| 215 | # is an identifier for the responsible component that will remove the entry |
| 216 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 217 | # in this list can only be removed. |
| 218 | # +patchStrategy=merge |
| 219 | "A String", |
| 220 | ], |
| 221 | "deletionTimestamp": "A String", # (Optional) |
| 222 | # |
| 223 | # Cloud Run fully managed: not supported |
| 224 | # |
| 225 | # Cloud Run for Anthos: supported |
| 226 | # |
| 227 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 228 | # deleted. This field is set by the server when a graceful deletion is |
| 229 | # requested by the user, and is not directly settable by a client. The |
| 230 | # resource is expected to be deleted (no longer visible from resource lists, |
| 231 | # and not reachable by name) after the time in this field, once the |
| 232 | # finalizers list is empty. As long as the finalizers list contains items, |
| 233 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 234 | # be unset or be set further into the future, although it may be shortened or |
| 235 | # the resource may be deleted prior to this time. For example, a user may |
| 236 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 237 | # sending a graceful termination signal to the containers in the pod. After |
| 238 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 239 | # to the container and after cleanup, remove the pod from the API. In the |
| 240 | # presence of network partitions, this object may still exist after this |
| 241 | # timestamp, until an administrator or automated process can determine the |
| 242 | # resource is fully terminated. |
| 243 | # If not set, graceful deletion of the object has not been requested. |
| 244 | # |
| 245 | # Populated by the system when a graceful deletion is requested. |
| 246 | # Read-only. |
| 247 | # More info: |
| 248 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 249 | "ownerReferences": [ # (Optional) |
| 250 | # |
| 251 | # Cloud Run fully managed: not supported |
| 252 | # |
| 253 | # Cloud Run for Anthos: supported |
| 254 | # |
| 255 | # List of objects that own this object. If ALL objects in the list have |
| 256 | # been deleted, this object will be garbage collected. |
| 257 | { # OwnerReference contains enough information to let you identify an owning |
| 258 | # object. Currently, an owning object must be in the same namespace, so there |
| 259 | # is no namespace field. |
| 260 | "controller": True or False, # If true, this reference points to the managing controller. |
| 261 | # +optional |
| 262 | "kind": "A String", # Kind of the referent. |
| 263 | # More info: |
| 264 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 265 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 266 | # the owner cannot be deleted from the key-value store until this |
| 267 | # reference is removed. |
| 268 | # Defaults to false. |
| 269 | # To set this field, a user needs "delete" permission of the owner, |
| 270 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 271 | # +optional |
| 272 | "apiVersion": "A String", # API version of the referent. |
| 273 | "name": "A String", # Name of the referent. |
| 274 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 275 | "uid": "A String", # UID of the referent. |
| 276 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 277 | }, |
| 278 | ], |
| 279 | "creationTimestamp": "A String", # (Optional) |
| 280 | # |
| 281 | # CreationTimestamp is a timestamp representing the server time when this |
| 282 | # object was created. It is not guaranteed to be set in happens-before order |
| 283 | # across separate operations. Clients may not set this value. It is |
| 284 | # represented in RFC3339 form and is in UTC. |
| 285 | # |
| 286 | # Populated by the system. |
| 287 | # Read-only. |
| 288 | # Null for lists. |
| 289 | # More info: |
| 290 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 291 | "labels": { # (Optional) |
| 292 | # |
| 293 | # Map of string keys and values that can be used to organize and categorize |
| 294 | # (scope and select) objects. May match selectors of replication controllers |
| 295 | # and routes. |
| 296 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 297 | "a_key": "A String", |
| 298 | }, |
| 299 | "generation": 42, # (Optional) |
| 300 | # |
| 301 | # A sequence number representing a specific generation of the desired state. |
| 302 | # Populated by the system. Read-only. |
| 303 | "resourceVersion": "A String", # (Optional) |
| 304 | # |
| 305 | # An opaque value that represents the internal version of this object that |
| 306 | # can be used by clients to determine when objects have changed. May be used |
| 307 | # for optimistic concurrency, change detection, and the watch operation on a |
| 308 | # resource or set of resources. Clients must treat these values as opaque and |
| 309 | # passed unmodified back to the server. They may only be valid for a |
| 310 | # particular resource or set of resources. |
| 311 | # |
| 312 | # Populated by the system. |
| 313 | # Read-only. |
| 314 | # Value must be treated as opaque by clients and . |
| 315 | # More info: |
| 316 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 317 | "selfLink": "A String", # (Optional) |
| 318 | # |
| 319 | # SelfLink is a URL representing this object. |
| 320 | # Populated by the system. |
| 321 | # Read-only. |
| 322 | # string selfLink = 4; |
| 323 | "uid": "A String", # (Optional) |
| 324 | # |
| 325 | # UID is the unique in time and space value for this object. It is typically |
| 326 | # generated by the server on successful creation of a resource and is not |
| 327 | # allowed to change on PUT operations. |
| 328 | # |
| 329 | # Populated by the system. |
| 330 | # Read-only. |
| 331 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 332 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 333 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 334 | # project ID or project number. |
| 335 | }, |
| 336 | } |
| 337 | |
| 338 | x__xgafv: string, V1 error format. |
| 339 | Allowed values |
| 340 | 1 - v1 error format |
| 341 | 2 - v2 error format |
| 342 | |
| 343 | Returns: |
| 344 | An object of the form: |
| 345 | |
| 346 | { # Resource to hold the state and status of a user's domain mapping. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 347 | "status": { # The current state of the Domain Mapping. # The current status of the DomainMapping. |
| 348 | "mappedRouteName": "A String", # The name of the route that the mapping currently points to. |
| 349 | "conditions": [ # Array of observed DomainMappingConditions, indicating the current state |
| 350 | # of the DomainMapping. |
| 351 | { # Condition defines a generic condition for a Resource |
| 352 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 353 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 354 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 355 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 356 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 357 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 358 | # See also: |
| 359 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 360 | # Types common to all resources include: |
| 361 | # * "Ready": True when the Resource is ready. |
| 362 | }, |
| 363 | ], |
| 364 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that |
| 365 | # was last processed by the controller. |
| 366 | # |
| 367 | # Clients polling for completed reconciliation should poll until |
| 368 | # observedGeneration = metadata.generation and the Ready condition's status |
| 369 | # is True or False. |
| 370 | "resourceRecords": [ # The resource records required to configure this domain mapping. These |
| 371 | # records must be added to the domain's DNS configuration in order to |
| 372 | # serve the application via this domain mapping. |
| 373 | { # A DNS resource record. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 374 | "name": "A String", # Relative name of the object affected by this record. Only applicable for |
| 375 | # `CNAME` records. Example: 'www'. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | "type": "A String", # Resource record type. Example: `AAAA`. |
| 377 | "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 |
| 378 | # (section 5) and RFC 1034 (section 3.6.1). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 379 | }, |
| 380 | ], |
| 381 | }, |
| 382 | "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". |
| 383 | "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 384 | "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set. |
| 385 | # It is recommended that the user leaves this empty to receive an error |
| 386 | # warning about a potential conflict and only set it once the respective UI |
| 387 | # has given such a warning. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 388 | "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to. |
| 389 | # The route must exist. |
| 390 | "certificateMode": "A String", # The mode of the certificate. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 391 | }, |
| 392 | "kind": "A String", # The kind of resource, in this case "DomainMapping". |
| 393 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate. |
| 394 | # persisted resources must have, which includes all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 395 | "annotations": { # (Optional) |
| 396 | # |
| 397 | # Annotations is an unstructured key value map stored with a resource that |
| 398 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 399 | # are not queryable and should be preserved when modifying objects. More |
| 400 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 401 | "a_key": "A String", |
| 402 | }, |
| 403 | "generateName": "A String", # (Optional) |
| 404 | # |
| 405 | # Cloud Run fully managed: not supported |
| 406 | # |
| 407 | # Cloud Run for Anthos: supported |
| 408 | # |
| 409 | # GenerateName is an optional prefix, used by the server, to generate a |
| 410 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 411 | # used, the name returned to the client will be different than the name |
| 412 | # passed. This value will also be combined with a unique suffix. The provided |
| 413 | # value has the same validation rules as the Name field, and may be truncated |
| 414 | # by the length of the suffix required to make the value unique on the |
| 415 | # server. |
| 416 | # |
| 417 | # If this field is specified and the generated name exists, the server will |
| 418 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 419 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 420 | # time allotted, and the client should retry (optionally after the time |
| 421 | # indicated in the Retry-After header). |
| 422 | # |
| 423 | # Applied only if Name is not specified. |
| 424 | # More info: |
| 425 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 426 | # string generateName = 2; |
| 427 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 428 | # Is required when creating |
| 429 | # resources, although some resources may allow a client to request the |
| 430 | # generation of an appropriate name automatically. Name is primarily intended |
| 431 | # for creation idempotence and configuration definition. Cannot be updated. |
| 432 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 433 | # +optional |
| 434 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 435 | # |
| 436 | # Cloud Run fully managed: not supported |
| 437 | # |
| 438 | # Cloud Run for Anthos: supported |
| 439 | # |
| 440 | # Number of seconds allowed for this object to gracefully terminate before |
| 441 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 442 | # set. May only be shortened. Read-only. |
| 443 | "clusterName": "A String", # (Optional) |
| 444 | # |
| 445 | # Cloud Run fully managed: not supported |
| 446 | # |
| 447 | # Cloud Run for Anthos: supported |
| 448 | # |
| 449 | # The name of the cluster which the object belongs to. |
| 450 | # This is used to distinguish resources with same name and namespace in |
| 451 | # different clusters. This field is not set anywhere right now and apiserver |
| 452 | # is going to ignore it if set in create or update request. |
| 453 | "finalizers": [ # (Optional) |
| 454 | # |
| 455 | # Cloud Run fully managed: not supported |
| 456 | # |
| 457 | # Cloud Run for Anthos: supported |
| 458 | # |
| 459 | # Must be empty before the object is deleted from the registry. Each entry |
| 460 | # is an identifier for the responsible component that will remove the entry |
| 461 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 462 | # in this list can only be removed. |
| 463 | # +patchStrategy=merge |
| 464 | "A String", |
| 465 | ], |
| 466 | "deletionTimestamp": "A String", # (Optional) |
| 467 | # |
| 468 | # Cloud Run fully managed: not supported |
| 469 | # |
| 470 | # Cloud Run for Anthos: supported |
| 471 | # |
| 472 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 473 | # deleted. This field is set by the server when a graceful deletion is |
| 474 | # requested by the user, and is not directly settable by a client. The |
| 475 | # resource is expected to be deleted (no longer visible from resource lists, |
| 476 | # and not reachable by name) after the time in this field, once the |
| 477 | # finalizers list is empty. As long as the finalizers list contains items, |
| 478 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 479 | # be unset or be set further into the future, although it may be shortened or |
| 480 | # the resource may be deleted prior to this time. For example, a user may |
| 481 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 482 | # sending a graceful termination signal to the containers in the pod. After |
| 483 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 484 | # to the container and after cleanup, remove the pod from the API. In the |
| 485 | # presence of network partitions, this object may still exist after this |
| 486 | # timestamp, until an administrator or automated process can determine the |
| 487 | # resource is fully terminated. |
| 488 | # If not set, graceful deletion of the object has not been requested. |
| 489 | # |
| 490 | # Populated by the system when a graceful deletion is requested. |
| 491 | # Read-only. |
| 492 | # More info: |
| 493 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 494 | "ownerReferences": [ # (Optional) |
| 495 | # |
| 496 | # Cloud Run fully managed: not supported |
| 497 | # |
| 498 | # Cloud Run for Anthos: supported |
| 499 | # |
| 500 | # List of objects that own this object. If ALL objects in the list have |
| 501 | # been deleted, this object will be garbage collected. |
| 502 | { # OwnerReference contains enough information to let you identify an owning |
| 503 | # object. Currently, an owning object must be in the same namespace, so there |
| 504 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 505 | "controller": True or False, # If true, this reference points to the managing controller. |
| 506 | # +optional |
| 507 | "kind": "A String", # Kind of the referent. |
| 508 | # More info: |
| 509 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 510 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 511 | # the owner cannot be deleted from the key-value store until this |
| 512 | # reference is removed. |
| 513 | # Defaults to false. |
| 514 | # To set this field, a user needs "delete" permission of the owner, |
| 515 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 516 | # +optional |
| 517 | "apiVersion": "A String", # API version of the referent. |
| 518 | "name": "A String", # Name of the referent. |
| 519 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 520 | "uid": "A String", # UID of the referent. |
| 521 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 522 | }, |
| 523 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 524 | "creationTimestamp": "A String", # (Optional) |
| 525 | # |
| 526 | # CreationTimestamp is a timestamp representing the server time when this |
| 527 | # object was created. It is not guaranteed to be set in happens-before order |
| 528 | # across separate operations. Clients may not set this value. It is |
| 529 | # represented in RFC3339 form and is in UTC. |
| 530 | # |
| 531 | # Populated by the system. |
| 532 | # Read-only. |
| 533 | # Null for lists. |
| 534 | # More info: |
| 535 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 536 | "labels": { # (Optional) |
| 537 | # |
| 538 | # Map of string keys and values that can be used to organize and categorize |
| 539 | # (scope and select) objects. May match selectors of replication controllers |
| 540 | # and routes. |
| 541 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 542 | "a_key": "A String", |
| 543 | }, |
| 544 | "generation": 42, # (Optional) |
| 545 | # |
| 546 | # A sequence number representing a specific generation of the desired state. |
| 547 | # Populated by the system. Read-only. |
| 548 | "resourceVersion": "A String", # (Optional) |
| 549 | # |
| 550 | # An opaque value that represents the internal version of this object that |
| 551 | # can be used by clients to determine when objects have changed. May be used |
| 552 | # for optimistic concurrency, change detection, and the watch operation on a |
| 553 | # resource or set of resources. Clients must treat these values as opaque and |
| 554 | # passed unmodified back to the server. They may only be valid for a |
| 555 | # particular resource or set of resources. |
| 556 | # |
| 557 | # Populated by the system. |
| 558 | # Read-only. |
| 559 | # Value must be treated as opaque by clients and . |
| 560 | # More info: |
| 561 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 562 | "selfLink": "A String", # (Optional) |
| 563 | # |
| 564 | # SelfLink is a URL representing this object. |
| 565 | # Populated by the system. |
| 566 | # Read-only. |
| 567 | # string selfLink = 4; |
| 568 | "uid": "A String", # (Optional) |
| 569 | # |
| 570 | # UID is the unique in time and space value for this object. It is typically |
| 571 | # generated by the server on successful creation of a resource and is not |
| 572 | # allowed to change on PUT operations. |
| 573 | # |
| 574 | # Populated by the system. |
| 575 | # Read-only. |
| 576 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 577 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 578 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 579 | # project ID or project number. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 580 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 581 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 582 | </div> |
| 583 | |
| 584 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 585 | <code class="details" id="delete">delete(name, propagationPolicy=None, kind=None, apiVersion=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 586 | <pre>Delete a domain mapping. |
| 587 | |
| 588 | Args: |
| 589 | name: string, The name of the domain mapping to delete. |
| 590 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 591 | or number. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 592 | propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores |
| 593 | this setting, and deletes in the background. Please see |
| 594 | kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for |
| 595 | more information. |
| 596 | kind: string, Cloud Run currently ignores this parameter. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 597 | apiVersion: string, Cloud Run currently ignores this parameter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 598 | x__xgafv: string, V1 error format. |
| 599 | Allowed values |
| 600 | 1 - v1 error format |
| 601 | 2 - v2 error format |
| 602 | |
| 603 | Returns: |
| 604 | An object of the form: |
| 605 | |
| 606 | { # Status is a return value for calls that don't return other objects |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 607 | "details": { # StatusDetails is a set of additional properties that MAY be set by the # Extended data associated with the reason. Each reason may define its |
| 608 | # own extended details. This field is optional and the data returned |
| 609 | # is not guaranteed to conform to any schema except that defined by |
| 610 | # the reason type. |
| 611 | # +optional |
| 612 | # server to provide additional information about a response. The Reason |
| 613 | # field of a Status object defines what attributes will be set. Clients |
| 614 | # must ignore fields that do not match the defined type of each attribute, |
| 615 | # and should assume that any attribute may be empty, invalid, or under |
| 616 | # defined. |
| 617 | "name": "A String", # The name attribute of the resource associated with the status StatusReason |
| 618 | # (when there is a single name which can be described). |
| 619 | # +optional |
| 620 | "uid": "A String", # UID of the resource. |
| 621 | # (when there is a single resource which can be described). |
| 622 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 623 | # +optional |
| 624 | "group": "A String", # The group attribute of the resource associated with the status |
| 625 | # StatusReason. +optional |
| 626 | "causes": [ # The Causes array includes more details associated with the StatusReason |
| 627 | # failure. Not all StatusReasons may provide detailed causes. |
| 628 | # +optional |
| 629 | { # StatusCause provides more information about an api.Status failure, including |
| 630 | # cases when multiple errors are encountered. |
| 631 | "message": "A String", # A human-readable description of the cause of the error. This field may be |
| 632 | # presented as-is to a reader. |
| 633 | # +optional |
| 634 | "reason": "A String", # A machine-readable description of the cause of the error. If this value is |
| 635 | # empty there is no information available. |
| 636 | # +optional |
| 637 | "field": "A String", # The field of the resource that has caused this error, as named by its JSON |
| 638 | # serialization. May include dot and postfix notation for nested attributes. |
| 639 | # Arrays are zero-indexed. Fields may appear more than once in an array of |
| 640 | # causes due to fields having multiple errors. |
| 641 | # Optional. |
| 642 | # |
| 643 | # Examples: |
| 644 | # "name" - the field "name" on the current resource |
| 645 | # "items[0].name" - the field "name" on the first array entry in "items" |
| 646 | # +optional |
| 647 | }, |
| 648 | ], |
| 649 | "kind": "A String", # The kind attribute of the resource associated with the status StatusReason. |
| 650 | # On some operations may differ from the requested resource Kind. |
| 651 | # More info: |
| 652 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 653 | # +optional |
| 654 | "retryAfterSeconds": 42, # If specified, the time in seconds before the operation should be retried. |
| 655 | # Some errors may indicate the client must take an alternate action - for |
| 656 | # those errors this field may indicate how long to wait before taking the |
| 657 | # alternate action. +optional |
| 658 | }, |
| 659 | "reason": "A String", # A machine-readable description of why this operation is in the |
| 660 | # "Failure" status. If this value is empty there |
| 661 | # is no information available. A Reason clarifies an HTTP status |
| 662 | # code but does not override it. |
| 663 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 664 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Standard list metadata. |
| 665 | # More info: |
| 666 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 667 | # +optional |
| 668 | # lists and various status objects. A resource may have only one of |
| 669 | # {ObjectMeta, ListMeta}. |
| 670 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 671 | # Populated by the system. |
| 672 | # Read-only. |
| 673 | # +optional |
| 674 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| 675 | # can be used by clients to determine when objects have changed. Value must |
| 676 | # be treated as opaque by clients and passed unmodified back to the server. |
| 677 | # Populated by the system. |
| 678 | # Read-only. |
| 679 | # More info: |
| 680 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 681 | # +optional |
| 682 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 683 | # returned, and indicates that the server has more data available. The value |
| 684 | # is opaque and may be used to issue another request to the endpoint that |
| 685 | # served this list to retrieve the next set of available objects. Continuing |
| 686 | # a list may not be possible if the server configuration has changed or more |
| 687 | # than a few minutes have passed. The resourceVersion field returned when |
| 688 | # using this continue value will be identical to the value in the first |
| 689 | # response. |
| 690 | }, |
| 691 | "code": 42, # Suggested HTTP return code for this status, 0 if not set. |
| 692 | # +optional |
| 693 | "message": "A String", # A human-readable description of the status of this operation. |
| 694 | # +optional |
| 695 | "status": "A String", # Status of the operation. |
| 696 | # One of: "Success" or "Failure". |
| 697 | # More info: |
| 698 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| 699 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 700 | }</pre> |
| 701 | </div> |
| 702 | |
| 703 | <div class="method"> |
| 704 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 705 | <pre>Get information about a domain mapping. |
| 706 | |
| 707 | Args: |
| 708 | name: string, The name of the domain mapping to retrieve. |
| 709 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 710 | or number. (required) |
| 711 | x__xgafv: string, V1 error format. |
| 712 | Allowed values |
| 713 | 1 - v1 error format |
| 714 | 2 - v2 error format |
| 715 | |
| 716 | Returns: |
| 717 | An object of the form: |
| 718 | |
| 719 | { # Resource to hold the state and status of a user's domain mapping. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 720 | "status": { # The current state of the Domain Mapping. # The current status of the DomainMapping. |
| 721 | "mappedRouteName": "A String", # The name of the route that the mapping currently points to. |
| 722 | "conditions": [ # Array of observed DomainMappingConditions, indicating the current state |
| 723 | # of the DomainMapping. |
| 724 | { # Condition defines a generic condition for a Resource |
| 725 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 726 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 727 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 728 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 729 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 730 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 731 | # See also: |
| 732 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 733 | # Types common to all resources include: |
| 734 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 735 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 736 | ], |
| 737 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that |
| 738 | # was last processed by the controller. |
| 739 | # |
| 740 | # Clients polling for completed reconciliation should poll until |
| 741 | # observedGeneration = metadata.generation and the Ready condition's status |
| 742 | # is True or False. |
| 743 | "resourceRecords": [ # The resource records required to configure this domain mapping. These |
| 744 | # records must be added to the domain's DNS configuration in order to |
| 745 | # serve the application via this domain mapping. |
| 746 | { # A DNS resource record. |
| 747 | "name": "A String", # Relative name of the object affected by this record. Only applicable for |
| 748 | # `CNAME` records. Example: 'www'. |
| 749 | "type": "A String", # Resource record type. Example: `AAAA`. |
| 750 | "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 |
| 751 | # (section 5) and RFC 1034 (section 3.6.1). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 752 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 753 | ], |
| 754 | }, |
| 755 | "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". |
| 756 | "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping. |
| 757 | "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set. |
| 758 | # It is recommended that the user leaves this empty to receive an error |
| 759 | # warning about a potential conflict and only set it once the respective UI |
| 760 | # has given such a warning. |
| 761 | "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to. |
| 762 | # The route must exist. |
| 763 | "certificateMode": "A String", # The mode of the certificate. |
| 764 | }, |
| 765 | "kind": "A String", # The kind of resource, in this case "DomainMapping". |
| 766 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate. |
| 767 | # persisted resources must have, which includes all objects users must create. |
| 768 | "annotations": { # (Optional) |
| 769 | # |
| 770 | # Annotations is an unstructured key value map stored with a resource that |
| 771 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 772 | # are not queryable and should be preserved when modifying objects. More |
| 773 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 774 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 775 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 776 | "generateName": "A String", # (Optional) |
| 777 | # |
| 778 | # Cloud Run fully managed: not supported |
| 779 | # |
| 780 | # Cloud Run for Anthos: supported |
| 781 | # |
| 782 | # GenerateName is an optional prefix, used by the server, to generate a |
| 783 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 784 | # used, the name returned to the client will be different than the name |
| 785 | # passed. This value will also be combined with a unique suffix. The provided |
| 786 | # value has the same validation rules as the Name field, and may be truncated |
| 787 | # by the length of the suffix required to make the value unique on the |
| 788 | # server. |
| 789 | # |
| 790 | # If this field is specified and the generated name exists, the server will |
| 791 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 792 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 793 | # time allotted, and the client should retry (optionally after the time |
| 794 | # indicated in the Retry-After header). |
| 795 | # |
| 796 | # Applied only if Name is not specified. |
| 797 | # More info: |
| 798 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 799 | # string generateName = 2; |
| 800 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 801 | # Is required when creating |
| 802 | # resources, although some resources may allow a client to request the |
| 803 | # generation of an appropriate name automatically. Name is primarily intended |
| 804 | # for creation idempotence and configuration definition. Cannot be updated. |
| 805 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 806 | # +optional |
| 807 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 808 | # |
| 809 | # Cloud Run fully managed: not supported |
| 810 | # |
| 811 | # Cloud Run for Anthos: supported |
| 812 | # |
| 813 | # Number of seconds allowed for this object to gracefully terminate before |
| 814 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 815 | # set. May only be shortened. Read-only. |
| 816 | "clusterName": "A String", # (Optional) |
| 817 | # |
| 818 | # Cloud Run fully managed: not supported |
| 819 | # |
| 820 | # Cloud Run for Anthos: supported |
| 821 | # |
| 822 | # The name of the cluster which the object belongs to. |
| 823 | # This is used to distinguish resources with same name and namespace in |
| 824 | # different clusters. This field is not set anywhere right now and apiserver |
| 825 | # is going to ignore it if set in create or update request. |
| 826 | "finalizers": [ # (Optional) |
| 827 | # |
| 828 | # Cloud Run fully managed: not supported |
| 829 | # |
| 830 | # Cloud Run for Anthos: supported |
| 831 | # |
| 832 | # Must be empty before the object is deleted from the registry. Each entry |
| 833 | # is an identifier for the responsible component that will remove the entry |
| 834 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 835 | # in this list can only be removed. |
| 836 | # +patchStrategy=merge |
| 837 | "A String", |
| 838 | ], |
| 839 | "deletionTimestamp": "A String", # (Optional) |
| 840 | # |
| 841 | # Cloud Run fully managed: not supported |
| 842 | # |
| 843 | # Cloud Run for Anthos: supported |
| 844 | # |
| 845 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 846 | # deleted. This field is set by the server when a graceful deletion is |
| 847 | # requested by the user, and is not directly settable by a client. The |
| 848 | # resource is expected to be deleted (no longer visible from resource lists, |
| 849 | # and not reachable by name) after the time in this field, once the |
| 850 | # finalizers list is empty. As long as the finalizers list contains items, |
| 851 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 852 | # be unset or be set further into the future, although it may be shortened or |
| 853 | # the resource may be deleted prior to this time. For example, a user may |
| 854 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 855 | # sending a graceful termination signal to the containers in the pod. After |
| 856 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 857 | # to the container and after cleanup, remove the pod from the API. In the |
| 858 | # presence of network partitions, this object may still exist after this |
| 859 | # timestamp, until an administrator or automated process can determine the |
| 860 | # resource is fully terminated. |
| 861 | # If not set, graceful deletion of the object has not been requested. |
| 862 | # |
| 863 | # Populated by the system when a graceful deletion is requested. |
| 864 | # Read-only. |
| 865 | # More info: |
| 866 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 867 | "ownerReferences": [ # (Optional) |
| 868 | # |
| 869 | # Cloud Run fully managed: not supported |
| 870 | # |
| 871 | # Cloud Run for Anthos: supported |
| 872 | # |
| 873 | # List of objects that own this object. If ALL objects in the list have |
| 874 | # been deleted, this object will be garbage collected. |
| 875 | { # OwnerReference contains enough information to let you identify an owning |
| 876 | # object. Currently, an owning object must be in the same namespace, so there |
| 877 | # is no namespace field. |
| 878 | "controller": True or False, # If true, this reference points to the managing controller. |
| 879 | # +optional |
| 880 | "kind": "A String", # Kind of the referent. |
| 881 | # More info: |
| 882 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 883 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 884 | # the owner cannot be deleted from the key-value store until this |
| 885 | # reference is removed. |
| 886 | # Defaults to false. |
| 887 | # To set this field, a user needs "delete" permission of the owner, |
| 888 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 889 | # +optional |
| 890 | "apiVersion": "A String", # API version of the referent. |
| 891 | "name": "A String", # Name of the referent. |
| 892 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 893 | "uid": "A String", # UID of the referent. |
| 894 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 895 | }, |
| 896 | ], |
| 897 | "creationTimestamp": "A String", # (Optional) |
| 898 | # |
| 899 | # CreationTimestamp is a timestamp representing the server time when this |
| 900 | # object was created. It is not guaranteed to be set in happens-before order |
| 901 | # across separate operations. Clients may not set this value. It is |
| 902 | # represented in RFC3339 form and is in UTC. |
| 903 | # |
| 904 | # Populated by the system. |
| 905 | # Read-only. |
| 906 | # Null for lists. |
| 907 | # More info: |
| 908 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 909 | "labels": { # (Optional) |
| 910 | # |
| 911 | # Map of string keys and values that can be used to organize and categorize |
| 912 | # (scope and select) objects. May match selectors of replication controllers |
| 913 | # and routes. |
| 914 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 915 | "a_key": "A String", |
| 916 | }, |
| 917 | "generation": 42, # (Optional) |
| 918 | # |
| 919 | # A sequence number representing a specific generation of the desired state. |
| 920 | # Populated by the system. Read-only. |
| 921 | "resourceVersion": "A String", # (Optional) |
| 922 | # |
| 923 | # An opaque value that represents the internal version of this object that |
| 924 | # can be used by clients to determine when objects have changed. May be used |
| 925 | # for optimistic concurrency, change detection, and the watch operation on a |
| 926 | # resource or set of resources. Clients must treat these values as opaque and |
| 927 | # passed unmodified back to the server. They may only be valid for a |
| 928 | # particular resource or set of resources. |
| 929 | # |
| 930 | # Populated by the system. |
| 931 | # Read-only. |
| 932 | # Value must be treated as opaque by clients and . |
| 933 | # More info: |
| 934 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 935 | "selfLink": "A String", # (Optional) |
| 936 | # |
| 937 | # SelfLink is a URL representing this object. |
| 938 | # Populated by the system. |
| 939 | # Read-only. |
| 940 | # string selfLink = 4; |
| 941 | "uid": "A String", # (Optional) |
| 942 | # |
| 943 | # UID is the unique in time and space value for this object. It is typically |
| 944 | # generated by the server on successful creation of a resource and is not |
| 945 | # allowed to change on PUT operations. |
| 946 | # |
| 947 | # Populated by the system. |
| 948 | # Read-only. |
| 949 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 950 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 951 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 952 | # project ID or project number. |
| 953 | }, |
| 954 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 955 | </div> |
| 956 | |
| 957 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 958 | <code class="details" id="list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 959 | <pre>List domain mappings. |
| 960 | |
| 961 | Args: |
| 962 | parent: string, The namespace from which the domain mappings should be listed. |
| 963 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 964 | or number. (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 965 | continue: string, Optional encoded string to continue paging. |
| 966 | limit: integer, The maximum number of records that should be returned. |
| 967 | watch: boolean, Flag that indicates that the client expects to watch this resource as well. |
| 968 | Not currently used by Cloud Run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 969 | labelSelector: string, Allows to filter resources based on a label. Supported operations are |
| 970 | =, !=, exists, in, and notIn. |
| 971 | fieldSelector: string, Allows to filter resources based on a specific value for a field name. |
| 972 | Send this in a query string format. i.e. 'metadata.name%3Dlorem'. |
| 973 | Not currently used by Cloud Run. |
| 974 | includeUninitialized: boolean, Not currently used by Cloud Run. |
| 975 | resourceVersion: string, The baseline resource version from which the list or watch operation should |
| 976 | start. Not currently used by Cloud Run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 977 | x__xgafv: string, V1 error format. |
| 978 | Allowed values |
| 979 | 1 - v1 error format |
| 980 | 2 - v2 error format |
| 981 | |
| 982 | Returns: |
| 983 | An object of the form: |
| 984 | |
| 985 | { # ListDomainMappingsResponse is a list of DomainMapping resources. |
| 986 | "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". |
| 987 | "kind": "A String", # The kind of this resource, in this case "DomainMappingList". |
| 988 | "unreachable": [ # Locations that could not be reached. |
| 989 | "A String", |
| 990 | ], |
| 991 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this DomainMapping list. |
| 992 | # lists and various status objects. A resource may have only one of |
| 993 | # {ObjectMeta, ListMeta}. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 994 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 995 | # Populated by the system. |
| 996 | # Read-only. |
| 997 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 998 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| 999 | # can be used by clients to determine when objects have changed. Value must |
| 1000 | # be treated as opaque by clients and passed unmodified back to the server. |
| 1001 | # Populated by the system. |
| 1002 | # Read-only. |
| 1003 | # More info: |
| 1004 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1005 | # +optional |
| 1006 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 1007 | # returned, and indicates that the server has more data available. The value |
| 1008 | # is opaque and may be used to issue another request to the endpoint that |
| 1009 | # served this list to retrieve the next set of available objects. Continuing |
| 1010 | # a list may not be possible if the server configuration has changed or more |
| 1011 | # than a few minutes have passed. The resourceVersion field returned when |
| 1012 | # using this continue value will be identical to the value in the first |
| 1013 | # response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1014 | }, |
| 1015 | "items": [ # List of DomainMappings. |
| 1016 | { # Resource to hold the state and status of a user's domain mapping. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1017 | "status": { # The current state of the Domain Mapping. # The current status of the DomainMapping. |
| 1018 | "mappedRouteName": "A String", # The name of the route that the mapping currently points to. |
| 1019 | "conditions": [ # Array of observed DomainMappingConditions, indicating the current state |
| 1020 | # of the DomainMapping. |
| 1021 | { # Condition defines a generic condition for a Resource |
| 1022 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 1023 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 1024 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 1025 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 1026 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 1027 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 1028 | # See also: |
| 1029 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 1030 | # Types common to all resources include: |
| 1031 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1032 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1033 | ], |
| 1034 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that |
| 1035 | # was last processed by the controller. |
| 1036 | # |
| 1037 | # Clients polling for completed reconciliation should poll until |
| 1038 | # observedGeneration = metadata.generation and the Ready condition's status |
| 1039 | # is True or False. |
| 1040 | "resourceRecords": [ # The resource records required to configure this domain mapping. These |
| 1041 | # records must be added to the domain's DNS configuration in order to |
| 1042 | # serve the application via this domain mapping. |
| 1043 | { # A DNS resource record. |
| 1044 | "name": "A String", # Relative name of the object affected by this record. Only applicable for |
| 1045 | # `CNAME` records. Example: 'www'. |
| 1046 | "type": "A String", # Resource record type. Example: `AAAA`. |
| 1047 | "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 |
| 1048 | # (section 5) and RFC 1034 (section 3.6.1). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1049 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1050 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1051 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1052 | "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". |
| 1053 | "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping. |
| 1054 | "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set. |
| 1055 | # It is recommended that the user leaves this empty to receive an error |
| 1056 | # warning about a potential conflict and only set it once the respective UI |
| 1057 | # has given such a warning. |
| 1058 | "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to. |
| 1059 | # The route must exist. |
| 1060 | "certificateMode": "A String", # The mode of the certificate. |
| 1061 | }, |
| 1062 | "kind": "A String", # The kind of resource, in this case "DomainMapping". |
| 1063 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate. |
| 1064 | # persisted resources must have, which includes all objects users must create. |
| 1065 | "annotations": { # (Optional) |
| 1066 | # |
| 1067 | # Annotations is an unstructured key value map stored with a resource that |
| 1068 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1069 | # are not queryable and should be preserved when modifying objects. More |
| 1070 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 1071 | "a_key": "A String", |
| 1072 | }, |
| 1073 | "generateName": "A String", # (Optional) |
| 1074 | # |
| 1075 | # Cloud Run fully managed: not supported |
| 1076 | # |
| 1077 | # Cloud Run for Anthos: supported |
| 1078 | # |
| 1079 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1080 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1081 | # used, the name returned to the client will be different than the name |
| 1082 | # passed. This value will also be combined with a unique suffix. The provided |
| 1083 | # value has the same validation rules as the Name field, and may be truncated |
| 1084 | # by the length of the suffix required to make the value unique on the |
| 1085 | # server. |
| 1086 | # |
| 1087 | # If this field is specified and the generated name exists, the server will |
| 1088 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1089 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1090 | # time allotted, and the client should retry (optionally after the time |
| 1091 | # indicated in the Retry-After header). |
| 1092 | # |
| 1093 | # Applied only if Name is not specified. |
| 1094 | # More info: |
| 1095 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1096 | # string generateName = 2; |
| 1097 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1098 | # Is required when creating |
| 1099 | # resources, although some resources may allow a client to request the |
| 1100 | # generation of an appropriate name automatically. Name is primarily intended |
| 1101 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1102 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1103 | # +optional |
| 1104 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 1105 | # |
| 1106 | # Cloud Run fully managed: not supported |
| 1107 | # |
| 1108 | # Cloud Run for Anthos: supported |
| 1109 | # |
| 1110 | # Number of seconds allowed for this object to gracefully terminate before |
| 1111 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1112 | # set. May only be shortened. Read-only. |
| 1113 | "clusterName": "A String", # (Optional) |
| 1114 | # |
| 1115 | # Cloud Run fully managed: not supported |
| 1116 | # |
| 1117 | # Cloud Run for Anthos: supported |
| 1118 | # |
| 1119 | # The name of the cluster which the object belongs to. |
| 1120 | # This is used to distinguish resources with same name and namespace in |
| 1121 | # different clusters. This field is not set anywhere right now and apiserver |
| 1122 | # is going to ignore it if set in create or update request. |
| 1123 | "finalizers": [ # (Optional) |
| 1124 | # |
| 1125 | # Cloud Run fully managed: not supported |
| 1126 | # |
| 1127 | # Cloud Run for Anthos: supported |
| 1128 | # |
| 1129 | # Must be empty before the object is deleted from the registry. Each entry |
| 1130 | # is an identifier for the responsible component that will remove the entry |
| 1131 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1132 | # in this list can only be removed. |
| 1133 | # +patchStrategy=merge |
| 1134 | "A String", |
| 1135 | ], |
| 1136 | "deletionTimestamp": "A String", # (Optional) |
| 1137 | # |
| 1138 | # Cloud Run fully managed: not supported |
| 1139 | # |
| 1140 | # Cloud Run for Anthos: supported |
| 1141 | # |
| 1142 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1143 | # deleted. This field is set by the server when a graceful deletion is |
| 1144 | # requested by the user, and is not directly settable by a client. The |
| 1145 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1146 | # and not reachable by name) after the time in this field, once the |
| 1147 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1148 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1149 | # be unset or be set further into the future, although it may be shortened or |
| 1150 | # the resource may be deleted prior to this time. For example, a user may |
| 1151 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1152 | # sending a graceful termination signal to the containers in the pod. After |
| 1153 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1154 | # to the container and after cleanup, remove the pod from the API. In the |
| 1155 | # presence of network partitions, this object may still exist after this |
| 1156 | # timestamp, until an administrator or automated process can determine the |
| 1157 | # resource is fully terminated. |
| 1158 | # If not set, graceful deletion of the object has not been requested. |
| 1159 | # |
| 1160 | # Populated by the system when a graceful deletion is requested. |
| 1161 | # Read-only. |
| 1162 | # More info: |
| 1163 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1164 | "ownerReferences": [ # (Optional) |
| 1165 | # |
| 1166 | # Cloud Run fully managed: not supported |
| 1167 | # |
| 1168 | # Cloud Run for Anthos: supported |
| 1169 | # |
| 1170 | # List of objects that own this object. If ALL objects in the list have |
| 1171 | # been deleted, this object will be garbage collected. |
| 1172 | { # OwnerReference contains enough information to let you identify an owning |
| 1173 | # object. Currently, an owning object must be in the same namespace, so there |
| 1174 | # is no namespace field. |
| 1175 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1176 | # +optional |
| 1177 | "kind": "A String", # Kind of the referent. |
| 1178 | # More info: |
| 1179 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1180 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1181 | # the owner cannot be deleted from the key-value store until this |
| 1182 | # reference is removed. |
| 1183 | # Defaults to false. |
| 1184 | # To set this field, a user needs "delete" permission of the owner, |
| 1185 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1186 | # +optional |
| 1187 | "apiVersion": "A String", # API version of the referent. |
| 1188 | "name": "A String", # Name of the referent. |
| 1189 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1190 | "uid": "A String", # UID of the referent. |
| 1191 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1192 | }, |
| 1193 | ], |
| 1194 | "creationTimestamp": "A String", # (Optional) |
| 1195 | # |
| 1196 | # CreationTimestamp is a timestamp representing the server time when this |
| 1197 | # object was created. It is not guaranteed to be set in happens-before order |
| 1198 | # across separate operations. Clients may not set this value. It is |
| 1199 | # represented in RFC3339 form and is in UTC. |
| 1200 | # |
| 1201 | # Populated by the system. |
| 1202 | # Read-only. |
| 1203 | # Null for lists. |
| 1204 | # More info: |
| 1205 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1206 | "labels": { # (Optional) |
| 1207 | # |
| 1208 | # Map of string keys and values that can be used to organize and categorize |
| 1209 | # (scope and select) objects. May match selectors of replication controllers |
| 1210 | # and routes. |
| 1211 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1212 | "a_key": "A String", |
| 1213 | }, |
| 1214 | "generation": 42, # (Optional) |
| 1215 | # |
| 1216 | # A sequence number representing a specific generation of the desired state. |
| 1217 | # Populated by the system. Read-only. |
| 1218 | "resourceVersion": "A String", # (Optional) |
| 1219 | # |
| 1220 | # An opaque value that represents the internal version of this object that |
| 1221 | # can be used by clients to determine when objects have changed. May be used |
| 1222 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1223 | # resource or set of resources. Clients must treat these values as opaque and |
| 1224 | # passed unmodified back to the server. They may only be valid for a |
| 1225 | # particular resource or set of resources. |
| 1226 | # |
| 1227 | # Populated by the system. |
| 1228 | # Read-only. |
| 1229 | # Value must be treated as opaque by clients and . |
| 1230 | # More info: |
| 1231 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1232 | "selfLink": "A String", # (Optional) |
| 1233 | # |
| 1234 | # SelfLink is a URL representing this object. |
| 1235 | # Populated by the system. |
| 1236 | # Read-only. |
| 1237 | # string selfLink = 4; |
| 1238 | "uid": "A String", # (Optional) |
| 1239 | # |
| 1240 | # UID is the unique in time and space value for this object. It is typically |
| 1241 | # generated by the server on successful creation of a resource and is not |
| 1242 | # allowed to change on PUT operations. |
| 1243 | # |
| 1244 | # Populated by the system. |
| 1245 | # Read-only. |
| 1246 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1247 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1248 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1249 | # project ID or project number. |
| 1250 | }, |
| 1251 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1252 | ], |
| 1253 | }</pre> |
| 1254 | </div> |
| 1255 | |
| 1256 | </body></html> |