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