| 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.routes.html">routes</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Get information about a route.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(parent, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, labelSelector=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <p class="firstline">List routes.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| 85 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 86 | <pre>Get information about a route. |
| 87 | |
| 88 | Args: |
| 89 | name: string, The name of the route to retrieve. |
| 90 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 91 | or number. (required) |
| 92 | x__xgafv: string, V1 error format. |
| 93 | Allowed values |
| 94 | 1 - v1 error format |
| 95 | 2 - v2 error format |
| 96 | |
| 97 | Returns: |
| 98 | An object of the form: |
| 99 | |
| 100 | { # Route is responsible for configuring ingress over a collection of Revisions. |
| 101 | # Some of the Revisions a Route distributes traffic over may be specified by |
| 102 | # referencing the Configuration responsible for creating them; in these cases |
| 103 | # the Route is additionally responsible for monitoring the Configuration for |
| 104 | # "latest ready" revision changes, and smoothly rolling out latest revisions. |
| 105 | # See also: |
| 106 | # https://github.com/knative/serving/blob/master/docs/spec/overview.md#route |
| 107 | # |
| 108 | # Cloud Run currently supports referencing a single Configuration to |
| 109 | # automatically deploy the "latest ready" Revision from that Configuration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | "kind": "A String", # The kind of this resource, in this case always "Route". |
| 111 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Route, including name, namespace, labels, |
| 112 | # and annotations. |
| 113 | # persisted resources must have, which includes all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | "annotations": { # (Optional) |
| 115 | # |
| 116 | # Annotations is an unstructured key value map stored with a resource that |
| 117 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 118 | # are not queryable and should be preserved when modifying objects. More |
| 119 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 120 | "a_key": "A String", |
| 121 | }, |
| 122 | "generateName": "A String", # (Optional) |
| 123 | # |
| 124 | # Cloud Run fully managed: not supported |
| 125 | # |
| 126 | # Cloud Run for Anthos: supported |
| 127 | # |
| 128 | # GenerateName is an optional prefix, used by the server, to generate a |
| 129 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 130 | # used, the name returned to the client will be different than the name |
| 131 | # passed. This value will also be combined with a unique suffix. The provided |
| 132 | # value has the same validation rules as the Name field, and may be truncated |
| 133 | # by the length of the suffix required to make the value unique on the |
| 134 | # server. |
| 135 | # |
| 136 | # If this field is specified and the generated name exists, the server will |
| 137 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 138 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 139 | # time allotted, and the client should retry (optionally after the time |
| 140 | # indicated in the Retry-After header). |
| 141 | # |
| 142 | # Applied only if Name is not specified. |
| 143 | # More info: |
| 144 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 145 | # string generateName = 2; |
| 146 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 147 | # Is required when creating |
| 148 | # resources, although some resources may allow a client to request the |
| 149 | # generation of an appropriate name automatically. Name is primarily intended |
| 150 | # for creation idempotence and configuration definition. Cannot be updated. |
| 151 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 152 | # +optional |
| 153 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 154 | # |
| 155 | # Cloud Run fully managed: not supported |
| 156 | # |
| 157 | # Cloud Run for Anthos: supported |
| 158 | # |
| 159 | # Number of seconds allowed for this object to gracefully terminate before |
| 160 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 161 | # set. May only be shortened. Read-only. |
| 162 | "clusterName": "A String", # (Optional) |
| 163 | # |
| 164 | # Cloud Run fully managed: not supported |
| 165 | # |
| 166 | # Cloud Run for Anthos: supported |
| 167 | # |
| 168 | # The name of the cluster which the object belongs to. |
| 169 | # This is used to distinguish resources with same name and namespace in |
| 170 | # different clusters. This field is not set anywhere right now and apiserver |
| 171 | # is going to ignore it if set in create or update request. |
| 172 | "finalizers": [ # (Optional) |
| 173 | # |
| 174 | # Cloud Run fully managed: not supported |
| 175 | # |
| 176 | # Cloud Run for Anthos: supported |
| 177 | # |
| 178 | # Must be empty before the object is deleted from the registry. Each entry |
| 179 | # is an identifier for the responsible component that will remove the entry |
| 180 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 181 | # in this list can only be removed. |
| 182 | # +patchStrategy=merge |
| 183 | "A String", |
| 184 | ], |
| 185 | "deletionTimestamp": "A String", # (Optional) |
| 186 | # |
| 187 | # Cloud Run fully managed: not supported |
| 188 | # |
| 189 | # Cloud Run for Anthos: supported |
| 190 | # |
| 191 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 192 | # deleted. This field is set by the server when a graceful deletion is |
| 193 | # requested by the user, and is not directly settable by a client. The |
| 194 | # resource is expected to be deleted (no longer visible from resource lists, |
| 195 | # and not reachable by name) after the time in this field, once the |
| 196 | # finalizers list is empty. As long as the finalizers list contains items, |
| 197 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 198 | # be unset or be set further into the future, although it may be shortened or |
| 199 | # the resource may be deleted prior to this time. For example, a user may |
| 200 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 201 | # sending a graceful termination signal to the containers in the pod. After |
| 202 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 203 | # to the container and after cleanup, remove the pod from the API. In the |
| 204 | # presence of network partitions, this object may still exist after this |
| 205 | # timestamp, until an administrator or automated process can determine the |
| 206 | # resource is fully terminated. |
| 207 | # If not set, graceful deletion of the object has not been requested. |
| 208 | # |
| 209 | # Populated by the system when a graceful deletion is requested. |
| 210 | # Read-only. |
| 211 | # More info: |
| 212 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 213 | "ownerReferences": [ # (Optional) |
| 214 | # |
| 215 | # Cloud Run fully managed: not supported |
| 216 | # |
| 217 | # Cloud Run for Anthos: supported |
| 218 | # |
| 219 | # List of objects that own this object. If ALL objects in the list have |
| 220 | # been deleted, this object will be garbage collected. |
| 221 | { # OwnerReference contains enough information to let you identify an owning |
| 222 | # object. Currently, an owning object must be in the same namespace, so there |
| 223 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 224 | "controller": True or False, # If true, this reference points to the managing controller. |
| 225 | # +optional |
| 226 | "kind": "A String", # Kind of the referent. |
| 227 | # More info: |
| 228 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 229 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 230 | # the owner cannot be deleted from the key-value store until this |
| 231 | # reference is removed. |
| 232 | # Defaults to false. |
| 233 | # To set this field, a user needs "delete" permission of the owner, |
| 234 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 235 | # +optional |
| 236 | "apiVersion": "A String", # API version of the referent. |
| 237 | "name": "A String", # Name of the referent. |
| 238 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 239 | "uid": "A String", # UID of the referent. |
| 240 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 241 | }, |
| 242 | ], |
| 243 | "creationTimestamp": "A String", # (Optional) |
| 244 | # |
| 245 | # CreationTimestamp is a timestamp representing the server time when this |
| 246 | # object was created. It is not guaranteed to be set in happens-before order |
| 247 | # across separate operations. Clients may not set this value. It is |
| 248 | # represented in RFC3339 form and is in UTC. |
| 249 | # |
| 250 | # Populated by the system. |
| 251 | # Read-only. |
| 252 | # Null for lists. |
| 253 | # More info: |
| 254 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 255 | "labels": { # (Optional) |
| 256 | # |
| 257 | # 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 | "a_key": "A String", |
| 262 | }, |
| 263 | "generation": 42, # (Optional) |
| 264 | # |
| 265 | # A sequence number representing a specific generation of the desired state. |
| 266 | # Populated by the system. Read-only. |
| 267 | "resourceVersion": "A String", # (Optional) |
| 268 | # |
| 269 | # An opaque value that represents the internal version of this object that |
| 270 | # can be used by clients to determine when objects have changed. May be used |
| 271 | # for optimistic concurrency, change detection, and the watch operation on a |
| 272 | # resource or set of resources. Clients must treat these values as opaque and |
| 273 | # passed unmodified back to the server. They may only be valid for a |
| 274 | # particular resource or set of resources. |
| 275 | # |
| 276 | # Populated by the system. |
| 277 | # Read-only. |
| 278 | # Value must be treated as opaque by clients and . |
| 279 | # More info: |
| 280 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 281 | "selfLink": "A String", # (Optional) |
| 282 | # |
| 283 | # SelfLink is a URL representing this object. |
| 284 | # Populated by the system. |
| 285 | # Read-only. |
| 286 | # string selfLink = 4; |
| 287 | "uid": "A String", # (Optional) |
| 288 | # |
| 289 | # UID is the unique in time and space value for this object. It is typically |
| 290 | # generated by the server on successful creation of a resource and is not |
| 291 | # allowed to change on PUT operations. |
| 292 | # |
| 293 | # Populated by the system. |
| 294 | # Read-only. |
| 295 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 296 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 297 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 298 | # project ID or project number. |
| 299 | }, |
| 300 | "status": { # RouteStatus communicates the observed state of the Route (from the # Status communicates the observed state of the Route (from the controller). |
| 301 | # controller). |
| 302 | "conditions": [ # Conditions communicates information about ongoing/complete |
| 303 | # reconciliation processes that bring the "spec" inline with the observed |
| 304 | # state of the world. |
| 305 | { # Condition defines a generic condition for a Resource |
| 306 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 307 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 308 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 309 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 310 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 311 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 312 | # See also: |
| 313 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 314 | # Types common to all resources include: |
| 315 | # * "Ready": True when the Resource is ready. |
| 316 | }, |
| 317 | ], |
| 318 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that |
| 319 | # was last processed by the controller. |
| 320 | # |
| 321 | # Clients polling for completed reconciliation should poll until |
| 322 | # observedGeneration = metadata.generation and the Ready condition's status |
| 323 | # is True or False. |
| 324 | # |
| 325 | # Note that providing a trafficTarget that only has a configurationName will |
| 326 | # result in a Route that does not increment either its metadata.generation or |
| 327 | # its observedGeneration, as new "latest ready" revisions from the |
| 328 | # Configuration are processed without an update to the Route's spec. |
| 329 | "address": { # Information for connecting over HTTP(s). # Similar to url, information on where the service is available on HTTP. |
| 330 | "url": "A String", |
| 331 | }, |
| 332 | "url": "A String", # URL holds the url that will distribute traffic over the provided traffic |
| 333 | # targets. It generally has the form: |
| 334 | # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
| 335 | "traffic": [ # Traffic holds the configured traffic distribution. |
| 336 | # These entries will always contain RevisionName references. |
| 337 | # When ConfigurationName appears in the spec, this will hold the |
| 338 | # LatestReadyRevisionName that we last observed. |
| 339 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 340 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 341 | # traffic. This is mutually exclusive with ConfigurationName. |
| 342 | # |
| 343 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 344 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 345 | # ready Revision of the Configuration should be used for this traffic |
| 346 | # target. When provided LatestRevision must be true if RevisionName is |
| 347 | # empty; it must be false when RevisionName is non-empty. |
| 348 | # |
| 349 | # +optional |
| 350 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 351 | # this target exclusively. |
| 352 | # |
| 353 | # Not currently supported in Cloud Run. |
| 354 | # +optional |
| 355 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 356 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 357 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 358 | # (e.g. basic auth, url path, etc. |
| 359 | # |
| 360 | # Not currently supported in Cloud Run. |
| 361 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 362 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 363 | # of the referenced configuration changes, we will automatically migrate |
| 364 | # traffic from the prior "latest ready" revision to the new one. This field |
| 365 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 366 | # with RevisionName. |
| 367 | # |
| 368 | # Cloud Run currently supports a single ConfigurationName. |
| 369 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 370 | # This defaults to zero if unspecified. |
| 371 | # |
| 372 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 373 | # TrafficTarget entry. |
| 374 | }, |
| 375 | ], |
| 376 | }, |
| 377 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 378 | "spec": { # RouteSpec holds the desired state of the Route (from the client). # Spec holds the desired state of the Route (from the client). |
| 379 | "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative |
| 380 | # Revisions and Configurations. |
| 381 | # Cloud Run currently supports a single configurationName. |
| 382 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 383 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 384 | # traffic. This is mutually exclusive with ConfigurationName. |
| 385 | # |
| 386 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 387 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 388 | # ready Revision of the Configuration should be used for this traffic |
| 389 | # target. When provided LatestRevision must be true if RevisionName is |
| 390 | # empty; it must be false when RevisionName is non-empty. |
| 391 | # |
| 392 | # +optional |
| 393 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 394 | # this target exclusively. |
| 395 | # |
| 396 | # Not currently supported in Cloud Run. |
| 397 | # +optional |
| 398 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 399 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 400 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 401 | # (e.g. basic auth, url path, etc. |
| 402 | # |
| 403 | # Not currently supported in Cloud Run. |
| 404 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 405 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 406 | # of the referenced configuration changes, we will automatically migrate |
| 407 | # traffic from the prior "latest ready" revision to the new one. This field |
| 408 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 409 | # with RevisionName. |
| 410 | # |
| 411 | # Cloud Run currently supports a single ConfigurationName. |
| 412 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 413 | # This defaults to zero if unspecified. |
| 414 | # |
| 415 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 416 | # TrafficTarget entry. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 417 | }, |
| 418 | ], |
| 419 | }, |
| 420 | }</pre> |
| 421 | </div> |
| 422 | |
| 423 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 424 | <code class="details" id="list">list(parent, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, labelSelector=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | <pre>List routes. |
| 426 | |
| 427 | Args: |
| 428 | parent: string, The namespace from which the routes should be listed. |
| 429 | For Cloud Run (fully managed), replace {namespace_id} with the project ID |
| 430 | or number. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 431 | resourceVersion: string, The baseline resource version from which the list or watch operation should |
| 432 | start. Not currently used by Cloud Run. |
| 433 | includeUninitialized: boolean, Not currently used by Cloud Run. |
| 434 | fieldSelector: string, Allows to filter resources based on a specific value for a field name. |
| 435 | Send this in a query string format. i.e. 'metadata.name%3Dlorem'. |
| 436 | Not currently used by Cloud Run. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 437 | continue: string, Optional encoded string to continue paging. |
| 438 | limit: integer, The maximum number of records that should be returned. |
| 439 | watch: boolean, Flag that indicates that the client expects to watch this resource as well. |
| 440 | Not currently used by Cloud Run. |
| 441 | labelSelector: string, Allows to filter resources based on a label. Supported operations are |
| 442 | =, !=, exists, in, and notIn. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 443 | x__xgafv: string, V1 error format. |
| 444 | Allowed values |
| 445 | 1 - v1 error format |
| 446 | 2 - v2 error format |
| 447 | |
| 448 | Returns: |
| 449 | An object of the form: |
| 450 | |
| 451 | { # ListRoutesResponse is a list of Route resources. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 452 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 453 | "kind": "A String", # The kind of this resource, in this case always "RouteList". |
| 454 | "unreachable": [ # Locations that could not be reached. |
| 455 | "A String", |
| 456 | ], |
| 457 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this Route list. |
| 458 | # lists and various status objects. A resource may have only one of |
| 459 | # {ObjectMeta, ListMeta}. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 460 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 461 | # Populated by the system. |
| 462 | # Read-only. |
| 463 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 464 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| 465 | # can be used by clients to determine when objects have changed. Value must |
| 466 | # be treated as opaque by clients and passed unmodified back to the server. |
| 467 | # Populated by the system. |
| 468 | # Read-only. |
| 469 | # More info: |
| 470 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 471 | # +optional |
| 472 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 473 | # returned, and indicates that the server has more data available. The value |
| 474 | # is opaque and may be used to issue another request to the endpoint that |
| 475 | # served this list to retrieve the next set of available objects. Continuing |
| 476 | # a list may not be possible if the server configuration has changed or more |
| 477 | # than a few minutes have passed. The resourceVersion field returned when |
| 478 | # using this continue value will be identical to the value in the first |
| 479 | # response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 480 | }, |
| 481 | "items": [ # List of Routes. |
| 482 | { # Route is responsible for configuring ingress over a collection of Revisions. |
| 483 | # Some of the Revisions a Route distributes traffic over may be specified by |
| 484 | # referencing the Configuration responsible for creating them; in these cases |
| 485 | # the Route is additionally responsible for monitoring the Configuration for |
| 486 | # "latest ready" revision changes, and smoothly rolling out latest revisions. |
| 487 | # See also: |
| 488 | # https://github.com/knative/serving/blob/master/docs/spec/overview.md#route |
| 489 | # |
| 490 | # Cloud Run currently supports referencing a single Configuration to |
| 491 | # automatically deploy the "latest ready" Revision from that Configuration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 492 | "kind": "A String", # The kind of this resource, in this case always "Route". |
| 493 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Route, including name, namespace, labels, |
| 494 | # and annotations. |
| 495 | # persisted resources must have, which includes all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 496 | "annotations": { # (Optional) |
| 497 | # |
| 498 | # Annotations is an unstructured key value map stored with a resource that |
| 499 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 500 | # are not queryable and should be preserved when modifying objects. More |
| 501 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 502 | "a_key": "A String", |
| 503 | }, |
| 504 | "generateName": "A String", # (Optional) |
| 505 | # |
| 506 | # Cloud Run fully managed: not supported |
| 507 | # |
| 508 | # Cloud Run for Anthos: supported |
| 509 | # |
| 510 | # GenerateName is an optional prefix, used by the server, to generate a |
| 511 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 512 | # used, the name returned to the client will be different than the name |
| 513 | # passed. This value will also be combined with a unique suffix. The provided |
| 514 | # value has the same validation rules as the Name field, and may be truncated |
| 515 | # by the length of the suffix required to make the value unique on the |
| 516 | # server. |
| 517 | # |
| 518 | # If this field is specified and the generated name exists, the server will |
| 519 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 520 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 521 | # time allotted, and the client should retry (optionally after the time |
| 522 | # indicated in the Retry-After header). |
| 523 | # |
| 524 | # Applied only if Name is not specified. |
| 525 | # More info: |
| 526 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 527 | # string generateName = 2; |
| 528 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 529 | # Is required when creating |
| 530 | # resources, although some resources may allow a client to request the |
| 531 | # generation of an appropriate name automatically. Name is primarily intended |
| 532 | # for creation idempotence and configuration definition. Cannot be updated. |
| 533 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 534 | # +optional |
| 535 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 536 | # |
| 537 | # Cloud Run fully managed: not supported |
| 538 | # |
| 539 | # Cloud Run for Anthos: supported |
| 540 | # |
| 541 | # Number of seconds allowed for this object to gracefully terminate before |
| 542 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 543 | # set. May only be shortened. Read-only. |
| 544 | "clusterName": "A String", # (Optional) |
| 545 | # |
| 546 | # Cloud Run fully managed: not supported |
| 547 | # |
| 548 | # Cloud Run for Anthos: supported |
| 549 | # |
| 550 | # The name of the cluster which the object belongs to. |
| 551 | # This is used to distinguish resources with same name and namespace in |
| 552 | # different clusters. This field is not set anywhere right now and apiserver |
| 553 | # is going to ignore it if set in create or update request. |
| 554 | "finalizers": [ # (Optional) |
| 555 | # |
| 556 | # Cloud Run fully managed: not supported |
| 557 | # |
| 558 | # Cloud Run for Anthos: supported |
| 559 | # |
| 560 | # Must be empty before the object is deleted from the registry. Each entry |
| 561 | # is an identifier for the responsible component that will remove the entry |
| 562 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 563 | # in this list can only be removed. |
| 564 | # +patchStrategy=merge |
| 565 | "A String", |
| 566 | ], |
| 567 | "deletionTimestamp": "A String", # (Optional) |
| 568 | # |
| 569 | # Cloud Run fully managed: not supported |
| 570 | # |
| 571 | # Cloud Run for Anthos: supported |
| 572 | # |
| 573 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 574 | # deleted. This field is set by the server when a graceful deletion is |
| 575 | # requested by the user, and is not directly settable by a client. The |
| 576 | # resource is expected to be deleted (no longer visible from resource lists, |
| 577 | # and not reachable by name) after the time in this field, once the |
| 578 | # finalizers list is empty. As long as the finalizers list contains items, |
| 579 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 580 | # be unset or be set further into the future, although it may be shortened or |
| 581 | # the resource may be deleted prior to this time. For example, a user may |
| 582 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 583 | # sending a graceful termination signal to the containers in the pod. After |
| 584 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 585 | # to the container and after cleanup, remove the pod from the API. In the |
| 586 | # presence of network partitions, this object may still exist after this |
| 587 | # timestamp, until an administrator or automated process can determine the |
| 588 | # resource is fully terminated. |
| 589 | # If not set, graceful deletion of the object has not been requested. |
| 590 | # |
| 591 | # Populated by the system when a graceful deletion is requested. |
| 592 | # Read-only. |
| 593 | # More info: |
| 594 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 595 | "ownerReferences": [ # (Optional) |
| 596 | # |
| 597 | # Cloud Run fully managed: not supported |
| 598 | # |
| 599 | # Cloud Run for Anthos: supported |
| 600 | # |
| 601 | # List of objects that own this object. If ALL objects in the list have |
| 602 | # been deleted, this object will be garbage collected. |
| 603 | { # OwnerReference contains enough information to let you identify an owning |
| 604 | # object. Currently, an owning object must be in the same namespace, so there |
| 605 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 606 | "controller": True or False, # If true, this reference points to the managing controller. |
| 607 | # +optional |
| 608 | "kind": "A String", # Kind of the referent. |
| 609 | # More info: |
| 610 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 611 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 612 | # the owner cannot be deleted from the key-value store until this |
| 613 | # reference is removed. |
| 614 | # Defaults to false. |
| 615 | # To set this field, a user needs "delete" permission of the owner, |
| 616 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 617 | # +optional |
| 618 | "apiVersion": "A String", # API version of the referent. |
| 619 | "name": "A String", # Name of the referent. |
| 620 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 621 | "uid": "A String", # UID of the referent. |
| 622 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 623 | }, |
| 624 | ], |
| 625 | "creationTimestamp": "A String", # (Optional) |
| 626 | # |
| 627 | # CreationTimestamp is a timestamp representing the server time when this |
| 628 | # object was created. It is not guaranteed to be set in happens-before order |
| 629 | # across separate operations. Clients may not set this value. It is |
| 630 | # represented in RFC3339 form and is in UTC. |
| 631 | # |
| 632 | # Populated by the system. |
| 633 | # Read-only. |
| 634 | # Null for lists. |
| 635 | # More info: |
| 636 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 637 | "labels": { # (Optional) |
| 638 | # |
| 639 | # Map of string keys and values that can be used to organize and categorize |
| 640 | # (scope and select) objects. May match selectors of replication controllers |
| 641 | # and routes. |
| 642 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 643 | "a_key": "A String", |
| 644 | }, |
| 645 | "generation": 42, # (Optional) |
| 646 | # |
| 647 | # A sequence number representing a specific generation of the desired state. |
| 648 | # Populated by the system. Read-only. |
| 649 | "resourceVersion": "A String", # (Optional) |
| 650 | # |
| 651 | # An opaque value that represents the internal version of this object that |
| 652 | # can be used by clients to determine when objects have changed. May be used |
| 653 | # for optimistic concurrency, change detection, and the watch operation on a |
| 654 | # resource or set of resources. Clients must treat these values as opaque and |
| 655 | # passed unmodified back to the server. They may only be valid for a |
| 656 | # particular resource or set of resources. |
| 657 | # |
| 658 | # Populated by the system. |
| 659 | # Read-only. |
| 660 | # Value must be treated as opaque by clients and . |
| 661 | # More info: |
| 662 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 663 | "selfLink": "A String", # (Optional) |
| 664 | # |
| 665 | # SelfLink is a URL representing this object. |
| 666 | # Populated by the system. |
| 667 | # Read-only. |
| 668 | # string selfLink = 4; |
| 669 | "uid": "A String", # (Optional) |
| 670 | # |
| 671 | # UID is the unique in time and space value for this object. It is typically |
| 672 | # generated by the server on successful creation of a resource and is not |
| 673 | # allowed to change on PUT operations. |
| 674 | # |
| 675 | # Populated by the system. |
| 676 | # Read-only. |
| 677 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 678 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 679 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 680 | # project ID or project number. |
| 681 | }, |
| 682 | "status": { # RouteStatus communicates the observed state of the Route (from the # Status communicates the observed state of the Route (from the controller). |
| 683 | # controller). |
| 684 | "conditions": [ # Conditions communicates information about ongoing/complete |
| 685 | # reconciliation processes that bring the "spec" inline with the observed |
| 686 | # state of the world. |
| 687 | { # Condition defines a generic condition for a Resource |
| 688 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 689 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 690 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 691 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 692 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 693 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 694 | # See also: |
| 695 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 696 | # Types common to all resources include: |
| 697 | # * "Ready": True when the Resource is ready. |
| 698 | }, |
| 699 | ], |
| 700 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that |
| 701 | # was last processed by the controller. |
| 702 | # |
| 703 | # Clients polling for completed reconciliation should poll until |
| 704 | # observedGeneration = metadata.generation and the Ready condition's status |
| 705 | # is True or False. |
| 706 | # |
| 707 | # Note that providing a trafficTarget that only has a configurationName will |
| 708 | # result in a Route that does not increment either its metadata.generation or |
| 709 | # its observedGeneration, as new "latest ready" revisions from the |
| 710 | # Configuration are processed without an update to the Route's spec. |
| 711 | "address": { # Information for connecting over HTTP(s). # Similar to url, information on where the service is available on HTTP. |
| 712 | "url": "A String", |
| 713 | }, |
| 714 | "url": "A String", # URL holds the url that will distribute traffic over the provided traffic |
| 715 | # targets. It generally has the form: |
| 716 | # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
| 717 | "traffic": [ # Traffic holds the configured traffic distribution. |
| 718 | # These entries will always contain RevisionName references. |
| 719 | # When ConfigurationName appears in the spec, this will hold the |
| 720 | # LatestReadyRevisionName that we last observed. |
| 721 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 722 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 723 | # traffic. This is mutually exclusive with ConfigurationName. |
| 724 | # |
| 725 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 726 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 727 | # ready Revision of the Configuration should be used for this traffic |
| 728 | # target. When provided LatestRevision must be true if RevisionName is |
| 729 | # empty; it must be false when RevisionName is non-empty. |
| 730 | # |
| 731 | # +optional |
| 732 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 733 | # this target exclusively. |
| 734 | # |
| 735 | # Not currently supported in Cloud Run. |
| 736 | # +optional |
| 737 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 738 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 739 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 740 | # (e.g. basic auth, url path, etc. |
| 741 | # |
| 742 | # Not currently supported in Cloud Run. |
| 743 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 744 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 745 | # of the referenced configuration changes, we will automatically migrate |
| 746 | # traffic from the prior "latest ready" revision to the new one. This field |
| 747 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 748 | # with RevisionName. |
| 749 | # |
| 750 | # Cloud Run currently supports a single ConfigurationName. |
| 751 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 752 | # This defaults to zero if unspecified. |
| 753 | # |
| 754 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 755 | # TrafficTarget entry. |
| 756 | }, |
| 757 | ], |
| 758 | }, |
| 759 | "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". |
| 760 | "spec": { # RouteSpec holds the desired state of the Route (from the client). # Spec holds the desired state of the Route (from the client). |
| 761 | "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative |
| 762 | # Revisions and Configurations. |
| 763 | # Cloud Run currently supports a single configurationName. |
| 764 | { # TrafficTarget holds a single entry of the routing table for a Route. |
| 765 | "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of |
| 766 | # traffic. This is mutually exclusive with ConfigurationName. |
| 767 | # |
| 768 | # Providing RevisionName in spec is not currently supported by Cloud Run. |
| 769 | "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest |
| 770 | # ready Revision of the Configuration should be used for this traffic |
| 771 | # target. When provided LatestRevision must be true if RevisionName is |
| 772 | # empty; it must be false when RevisionName is non-empty. |
| 773 | # |
| 774 | # +optional |
| 775 | "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing |
| 776 | # this target exclusively. |
| 777 | # |
| 778 | # Not currently supported in Cloud Run. |
| 779 | # +optional |
| 780 | "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL |
| 781 | # is displayed in status, and is disallowed on spec. URL must contain a |
| 782 | # scheme (e.g. http://) and a hostname, but may not contain anything else |
| 783 | # (e.g. basic auth, url path, etc. |
| 784 | # |
| 785 | # Not currently supported in Cloud Run. |
| 786 | "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will |
| 787 | # send this portion of traffic. When the "status.latestReadyRevisionName" |
| 788 | # of the referenced configuration changes, we will automatically migrate |
| 789 | # traffic from the prior "latest ready" revision to the new one. This field |
| 790 | # is never set in Route's status, only its spec. This is mutually exclusive |
| 791 | # with RevisionName. |
| 792 | # |
| 793 | # Cloud Run currently supports a single ConfigurationName. |
| 794 | "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration. |
| 795 | # This defaults to zero if unspecified. |
| 796 | # |
| 797 | # Cloud Run currently requires 100 percent for a single ConfigurationName |
| 798 | # TrafficTarget entry. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 799 | }, |
| 800 | ], |
| 801 | }, |
| 802 | }, |
| 803 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 804 | }</pre> |
| 805 | </div> |
| 806 | |
| 807 | </body></html> |