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