docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/run_v1.projects.locations.routes.html b/docs/dyn/run_v1.projects.locations.routes.html
index a7d873a..da771bc 100644
--- a/docs/dyn/run_v1.projects.locations.routes.html
+++ b/docs/dyn/run_v1.projects.locations.routes.html
@@ -78,7 +78,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get information about a route.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, x__xgafv=None)</a></code></p>
<p class="firstline">List routes.</p>
<h3>Method Details</h3>
<div class="method">
@@ -107,186 +107,10 @@
#
# Cloud Run currently supports referencing a single Configuration to
# automatically deploy the "latest ready" Revision from that Configuration.
- "status": { # RouteStatus communicates the observed state of the Route (from the # Status communicates the observed state of the Route (from the controller).
- # controller).
- "conditions": [ # Conditions communicates information about ongoing/complete
- # reconciliation processes that bring the "spec" inline with the observed
- # state of the world.
- { # Condition defines a generic condition for a Resource
- "message": "A String", # Optional. Human readable message indicating details about the current status.
- "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
- "status": "A String", # Status of the condition, one of True, False, Unknown.
- "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info
- "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.
- "type": "A String", # type is used to communicate the status of the reconciliation process.
- # See also:
- # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting
- # Types common to all resources include:
- # * "Ready": True when the Resource is ready.
- },
- ],
- "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that
- # was last processed by the controller.
- #
- # Clients polling for completed reconciliation should poll until
- # observedGeneration = metadata.generation and the Ready condition's status
- # is True or False.
- #
- # Note that providing a trafficTarget that only has a configurationName will
- # result in a Route that does not increment either its metadata.generation or
- # its observedGeneration, as new "latest ready" revisions from the
- # Configuration are processed without an update to the Route's spec.
- "address": { # Information for connecting over HTTP(s). # Similar to url, information on where the service is available on HTTP.
- "url": "A String",
- },
- "url": "A String", # URL holds the url that will distribute traffic over the provided traffic
- # targets. It generally has the form:
- # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app
- "traffic": [ # Traffic holds the configured traffic distribution.
- # These entries will always contain RevisionName references.
- # When ConfigurationName appears in the spec, this will hold the
- # LatestReadyRevisionName that we last observed.
- { # TrafficTarget holds a single entry of the routing table for a Route.
- "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL
- # is displayed in status, and is disallowed on spec. URL must contain a
- # scheme (e.g. http://) and a hostname, but may not contain anything else
- # (e.g. basic auth, url path, etc.
- #
- # Not currently supported in Cloud Run.
- "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will
- # send this portion of traffic. When the "status.latestReadyRevisionName"
- # of the referenced configuration changes, we will automatically migrate
- # traffic from the prior "latest ready" revision to the new one. This field
- # is never set in Route's status, only its spec. This is mutually exclusive
- # with RevisionName.
- #
- # Cloud Run currently supports a single ConfigurationName.
- "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.
- # This defaults to zero if unspecified.
- #
- # Cloud Run currently requires 100 percent for a single ConfigurationName
- # TrafficTarget entry.
- "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of
- # traffic. This is mutually exclusive with ConfigurationName.
- #
- # Providing RevisionName in spec is not currently supported by Cloud Run.
- "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest
- # ready Revision of the Configuration should be used for this traffic
- # target. When provided LatestRevision must be true if RevisionName is
- # empty; it must be false when RevisionName is non-empty.
- #
- # +optional
- "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing
- # this target exclusively.
- #
- # Not currently supported in Cloud Run.
- # +optional
- },
- ],
- },
- "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
- "spec": { # RouteSpec holds the desired state of the Route (from the client). # Spec holds the desired state of the Route (from the client).
- "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative
- # Revisions and Configurations.
- # Cloud Run currently supports a single configurationName.
- { # TrafficTarget holds a single entry of the routing table for a Route.
- "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL
- # is displayed in status, and is disallowed on spec. URL must contain a
- # scheme (e.g. http://) and a hostname, but may not contain anything else
- # (e.g. basic auth, url path, etc.
- #
- # Not currently supported in Cloud Run.
- "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will
- # send this portion of traffic. When the "status.latestReadyRevisionName"
- # of the referenced configuration changes, we will automatically migrate
- # traffic from the prior "latest ready" revision to the new one. This field
- # is never set in Route's status, only its spec. This is mutually exclusive
- # with RevisionName.
- #
- # Cloud Run currently supports a single ConfigurationName.
- "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.
- # This defaults to zero if unspecified.
- #
- # Cloud Run currently requires 100 percent for a single ConfigurationName
- # TrafficTarget entry.
- "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of
- # traffic. This is mutually exclusive with ConfigurationName.
- #
- # Providing RevisionName in spec is not currently supported by Cloud Run.
- "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest
- # ready Revision of the Configuration should be used for this traffic
- # target. When provided LatestRevision must be true if RevisionName is
- # empty; it must be false when RevisionName is non-empty.
- #
- # +optional
- "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing
- # this target exclusively.
- #
- # Not currently supported in Cloud Run.
- # +optional
- },
- ],
- },
"kind": "A String", # The kind of this resource, in this case always "Route".
"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Route, including name, namespace, labels,
# and annotations.
# persisted resources must have, which includes all objects users must create.
- "creationTimestamp": "A String", # (Optional)
- #
- # CreationTimestamp is a timestamp representing the server time when this
- # object was created. It is not guaranteed to be set in happens-before order
- # across separate operations. Clients may not set this value. It is
- # represented in RFC3339 form and is in UTC.
- #
- # Populated by the system.
- # Read-only.
- # Null for lists.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
- "labels": { # (Optional)
- #
- # Map of string keys and values that can be used to organize and categorize
- # (scope and select) objects. May match selectors of replication controllers
- # and routes.
- # More info: http://kubernetes.io/docs/user-guide/labels
- "a_key": "A String",
- },
- "generation": 42, # (Optional)
- #
- # A sequence number representing a specific generation of the desired state.
- # Populated by the system. Read-only.
- "resourceVersion": "A String", # (Optional)
- #
- # An opaque value that represents the internal version of this object that
- # can be used by clients to determine when objects have changed. May be used
- # for optimistic concurrency, change detection, and the watch operation on a
- # resource or set of resources. Clients must treat these values as opaque and
- # passed unmodified back to the server. They may only be valid for a
- # particular resource or set of resources.
- #
- # Populated by the system.
- # Read-only.
- # Value must be treated as opaque by clients and .
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- "selfLink": "A String", # (Optional)
- #
- # SelfLink is a URL representing this object.
- # Populated by the system.
- # Read-only.
- # string selfLink = 4;
- "uid": "A String", # (Optional)
- #
- # UID is the unique in time and space value for this object. It is typically
- # generated by the server on successful creation of a resource and is not
- # allowed to change on PUT operations.
- #
- # Populated by the system.
- # Read-only.
- # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- "namespace": "A String", # Namespace defines the space within each name must be unique, within a
- # Cloud Run region. In Cloud Run the namespace must be equal to either the
- # project ID or project number.
"annotations": { # (Optional)
#
# Annotations is an unstructured key value map stored with a resource that
@@ -397,8 +221,6 @@
{ # OwnerReference contains enough information to let you identify an owning
# object. Currently, an owning object must be in the same namespace, so there
# is no namespace field.
- "uid": "A String", # UID of the referent.
- # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
"controller": True or False, # If true, this reference points to the managing controller.
# +optional
"kind": "A String", # Kind of the referent.
@@ -414,6 +236,184 @@
"apiVersion": "A String", # API version of the referent.
"name": "A String", # Name of the referent.
# More info: http://kubernetes.io/docs/user-guide/identifiers#names
+ "uid": "A String", # UID of the referent.
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+ },
+ ],
+ "creationTimestamp": "A String", # (Optional)
+ #
+ # CreationTimestamp is a timestamp representing the server time when this
+ # object was created. It is not guaranteed to be set in happens-before order
+ # across separate operations. Clients may not set this value. It is
+ # represented in RFC3339 form and is in UTC.
+ #
+ # Populated by the system.
+ # Read-only.
+ # Null for lists.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+ "labels": { # (Optional)
+ #
+ # Map of string keys and values that can be used to organize and categorize
+ # (scope and select) objects. May match selectors of replication controllers
+ # and routes.
+ # More info: http://kubernetes.io/docs/user-guide/labels
+ "a_key": "A String",
+ },
+ "generation": 42, # (Optional)
+ #
+ # A sequence number representing a specific generation of the desired state.
+ # Populated by the system. Read-only.
+ "resourceVersion": "A String", # (Optional)
+ #
+ # An opaque value that represents the internal version of this object that
+ # can be used by clients to determine when objects have changed. May be used
+ # for optimistic concurrency, change detection, and the watch operation on a
+ # resource or set of resources. Clients must treat these values as opaque and
+ # passed unmodified back to the server. They may only be valid for a
+ # particular resource or set of resources.
+ #
+ # Populated by the system.
+ # Read-only.
+ # Value must be treated as opaque by clients and .
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
+ "selfLink": "A String", # (Optional)
+ #
+ # SelfLink is a URL representing this object.
+ # Populated by the system.
+ # Read-only.
+ # string selfLink = 4;
+ "uid": "A String", # (Optional)
+ #
+ # UID is the unique in time and space value for this object. It is typically
+ # generated by the server on successful creation of a resource and is not
+ # allowed to change on PUT operations.
+ #
+ # Populated by the system.
+ # Read-only.
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+ "namespace": "A String", # Namespace defines the space within each name must be unique, within a
+ # Cloud Run region. In Cloud Run the namespace must be equal to either the
+ # project ID or project number.
+ },
+ "status": { # RouteStatus communicates the observed state of the Route (from the # Status communicates the observed state of the Route (from the controller).
+ # controller).
+ "conditions": [ # Conditions communicates information about ongoing/complete
+ # reconciliation processes that bring the "spec" inline with the observed
+ # state of the world.
+ { # Condition defines a generic condition for a Resource
+ "message": "A String", # Optional. Human readable message indicating details about the current status.
+ "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
+ "status": "A String", # Status of the condition, one of True, False, Unknown.
+ "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info
+ "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.
+ "type": "A String", # type is used to communicate the status of the reconciliation process.
+ # See also:
+ # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting
+ # Types common to all resources include:
+ # * "Ready": True when the Resource is ready.
+ },
+ ],
+ "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that
+ # was last processed by the controller.
+ #
+ # Clients polling for completed reconciliation should poll until
+ # observedGeneration = metadata.generation and the Ready condition's status
+ # is True or False.
+ #
+ # Note that providing a trafficTarget that only has a configurationName will
+ # result in a Route that does not increment either its metadata.generation or
+ # its observedGeneration, as new "latest ready" revisions from the
+ # Configuration are processed without an update to the Route's spec.
+ "address": { # Information for connecting over HTTP(s). # Similar to url, information on where the service is available on HTTP.
+ "url": "A String",
+ },
+ "url": "A String", # URL holds the url that will distribute traffic over the provided traffic
+ # targets. It generally has the form:
+ # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app
+ "traffic": [ # Traffic holds the configured traffic distribution.
+ # These entries will always contain RevisionName references.
+ # When ConfigurationName appears in the spec, this will hold the
+ # LatestReadyRevisionName that we last observed.
+ { # TrafficTarget holds a single entry of the routing table for a Route.
+ "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of
+ # traffic. This is mutually exclusive with ConfigurationName.
+ #
+ # Providing RevisionName in spec is not currently supported by Cloud Run.
+ "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest
+ # ready Revision of the Configuration should be used for this traffic
+ # target. When provided LatestRevision must be true if RevisionName is
+ # empty; it must be false when RevisionName is non-empty.
+ #
+ # +optional
+ "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing
+ # this target exclusively.
+ #
+ # Not currently supported in Cloud Run.
+ # +optional
+ "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL
+ # is displayed in status, and is disallowed on spec. URL must contain a
+ # scheme (e.g. http://) and a hostname, but may not contain anything else
+ # (e.g. basic auth, url path, etc.
+ #
+ # Not currently supported in Cloud Run.
+ "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will
+ # send this portion of traffic. When the "status.latestReadyRevisionName"
+ # of the referenced configuration changes, we will automatically migrate
+ # traffic from the prior "latest ready" revision to the new one. This field
+ # is never set in Route's status, only its spec. This is mutually exclusive
+ # with RevisionName.
+ #
+ # Cloud Run currently supports a single ConfigurationName.
+ "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.
+ # This defaults to zero if unspecified.
+ #
+ # Cloud Run currently requires 100 percent for a single ConfigurationName
+ # TrafficTarget entry.
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
+ "spec": { # RouteSpec holds the desired state of the Route (from the client). # Spec holds the desired state of the Route (from the client).
+ "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative
+ # Revisions and Configurations.
+ # Cloud Run currently supports a single configurationName.
+ { # TrafficTarget holds a single entry of the routing table for a Route.
+ "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of
+ # traffic. This is mutually exclusive with ConfigurationName.
+ #
+ # Providing RevisionName in spec is not currently supported by Cloud Run.
+ "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest
+ # ready Revision of the Configuration should be used for this traffic
+ # target. When provided LatestRevision must be true if RevisionName is
+ # empty; it must be false when RevisionName is non-empty.
+ #
+ # +optional
+ "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing
+ # this target exclusively.
+ #
+ # Not currently supported in Cloud Run.
+ # +optional
+ "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL
+ # is displayed in status, and is disallowed on spec. URL must contain a
+ # scheme (e.g. http://) and a hostname, but may not contain anything else
+ # (e.g. basic auth, url path, etc.
+ #
+ # Not currently supported in Cloud Run.
+ "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will
+ # send this portion of traffic. When the "status.latestReadyRevisionName"
+ # of the referenced configuration changes, we will automatically migrate
+ # traffic from the prior "latest ready" revision to the new one. This field
+ # is never set in Route's status, only its spec. This is mutually exclusive
+ # with RevisionName.
+ #
+ # Cloud Run currently supports a single ConfigurationName.
+ "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.
+ # This defaults to zero if unspecified.
+ #
+ # Cloud Run currently requires 100 percent for a single ConfigurationName
+ # TrafficTarget entry.
},
],
},
@@ -421,13 +421,17 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, watch=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, x__xgafv=None)</code>
<pre>List routes.
Args:
parent: string, The namespace from which the routes should be listed.
For Cloud Run (fully managed), replace {namespace_id} with the project ID
or number. (required)
+ continue: string, Optional encoded string to continue paging.
+ limit: integer, The maximum number of records that should be returned.
+ watch: boolean, Flag that indicates that the client expects to watch this resource as well.
+Not currently used by Cloud Run.
labelSelector: string, Allows to filter resources based on a label. Supported operations are
=, !=, exists, in, and notIn.
resourceVersion: string, The baseline resource version from which the list or watch operation should
@@ -436,10 +440,6 @@
fieldSelector: string, Allows to filter resources based on a specific value for a field name.
Send this in a query string format. i.e. 'metadata.name%3Dlorem'.
Not currently used by Cloud Run.
- continue: string, Optional encoded string to continue paging.
- limit: integer, The maximum number of records that should be returned.
- watch: boolean, Flag that indicates that the client expects to watch this resource as well.
-Not currently used by Cloud Run.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -449,6 +449,7 @@
An object of the form:
{ # ListRoutesResponse is a list of Route resources.
+ "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
"kind": "A String", # The kind of this resource, in this case always "RouteList".
"unreachable": [ # Locations that could not be reached.
"A String",
@@ -456,6 +457,10 @@
"metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this Route list.
# lists and various status objects. A resource may have only one of
# {ObjectMeta, ListMeta}.
+ "selfLink": "A String", # SelfLink is a URL representing this object.
+ # Populated by the system.
+ # Read-only.
+ # +optional
"resourceVersion": "A String", # String that identifies the server's internal version of this object that
# can be used by clients to determine when objects have changed. Value must
# be treated as opaque by clients and passed unmodified back to the server.
@@ -472,10 +477,6 @@
# than a few minutes have passed. The resourceVersion field returned when
# using this continue value will be identical to the value in the first
# response.
- "selfLink": "A String", # SelfLink is a URL representing this object.
- # Populated by the system.
- # Read-only.
- # +optional
},
"items": [ # List of Routes.
{ # Route is responsible for configuring ingress over a collection of Revisions.
@@ -488,186 +489,10 @@
#
# Cloud Run currently supports referencing a single Configuration to
# automatically deploy the "latest ready" Revision from that Configuration.
- "status": { # RouteStatus communicates the observed state of the Route (from the # Status communicates the observed state of the Route (from the controller).
- # controller).
- "conditions": [ # Conditions communicates information about ongoing/complete
- # reconciliation processes that bring the "spec" inline with the observed
- # state of the world.
- { # Condition defines a generic condition for a Resource
- "message": "A String", # Optional. Human readable message indicating details about the current status.
- "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
- "status": "A String", # Status of the condition, one of True, False, Unknown.
- "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info
- "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.
- "type": "A String", # type is used to communicate the status of the reconciliation process.
- # See also:
- # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting
- # Types common to all resources include:
- # * "Ready": True when the Resource is ready.
- },
- ],
- "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that
- # was last processed by the controller.
- #
- # Clients polling for completed reconciliation should poll until
- # observedGeneration = metadata.generation and the Ready condition's status
- # is True or False.
- #
- # Note that providing a trafficTarget that only has a configurationName will
- # result in a Route that does not increment either its metadata.generation or
- # its observedGeneration, as new "latest ready" revisions from the
- # Configuration are processed without an update to the Route's spec.
- "address": { # Information for connecting over HTTP(s). # Similar to url, information on where the service is available on HTTP.
- "url": "A String",
- },
- "url": "A String", # URL holds the url that will distribute traffic over the provided traffic
- # targets. It generally has the form:
- # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app
- "traffic": [ # Traffic holds the configured traffic distribution.
- # These entries will always contain RevisionName references.
- # When ConfigurationName appears in the spec, this will hold the
- # LatestReadyRevisionName that we last observed.
- { # TrafficTarget holds a single entry of the routing table for a Route.
- "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL
- # is displayed in status, and is disallowed on spec. URL must contain a
- # scheme (e.g. http://) and a hostname, but may not contain anything else
- # (e.g. basic auth, url path, etc.
- #
- # Not currently supported in Cloud Run.
- "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will
- # send this portion of traffic. When the "status.latestReadyRevisionName"
- # of the referenced configuration changes, we will automatically migrate
- # traffic from the prior "latest ready" revision to the new one. This field
- # is never set in Route's status, only its spec. This is mutually exclusive
- # with RevisionName.
- #
- # Cloud Run currently supports a single ConfigurationName.
- "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.
- # This defaults to zero if unspecified.
- #
- # Cloud Run currently requires 100 percent for a single ConfigurationName
- # TrafficTarget entry.
- "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of
- # traffic. This is mutually exclusive with ConfigurationName.
- #
- # Providing RevisionName in spec is not currently supported by Cloud Run.
- "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest
- # ready Revision of the Configuration should be used for this traffic
- # target. When provided LatestRevision must be true if RevisionName is
- # empty; it must be false when RevisionName is non-empty.
- #
- # +optional
- "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing
- # this target exclusively.
- #
- # Not currently supported in Cloud Run.
- # +optional
- },
- ],
- },
- "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
- "spec": { # RouteSpec holds the desired state of the Route (from the client). # Spec holds the desired state of the Route (from the client).
- "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative
- # Revisions and Configurations.
- # Cloud Run currently supports a single configurationName.
- { # TrafficTarget holds a single entry of the routing table for a Route.
- "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL
- # is displayed in status, and is disallowed on spec. URL must contain a
- # scheme (e.g. http://) and a hostname, but may not contain anything else
- # (e.g. basic auth, url path, etc.
- #
- # Not currently supported in Cloud Run.
- "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will
- # send this portion of traffic. When the "status.latestReadyRevisionName"
- # of the referenced configuration changes, we will automatically migrate
- # traffic from the prior "latest ready" revision to the new one. This field
- # is never set in Route's status, only its spec. This is mutually exclusive
- # with RevisionName.
- #
- # Cloud Run currently supports a single ConfigurationName.
- "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.
- # This defaults to zero if unspecified.
- #
- # Cloud Run currently requires 100 percent for a single ConfigurationName
- # TrafficTarget entry.
- "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of
- # traffic. This is mutually exclusive with ConfigurationName.
- #
- # Providing RevisionName in spec is not currently supported by Cloud Run.
- "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest
- # ready Revision of the Configuration should be used for this traffic
- # target. When provided LatestRevision must be true if RevisionName is
- # empty; it must be false when RevisionName is non-empty.
- #
- # +optional
- "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing
- # this target exclusively.
- #
- # Not currently supported in Cloud Run.
- # +optional
- },
- ],
- },
"kind": "A String", # The kind of this resource, in this case always "Route".
"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Route, including name, namespace, labels,
# and annotations.
# persisted resources must have, which includes all objects users must create.
- "creationTimestamp": "A String", # (Optional)
- #
- # CreationTimestamp is a timestamp representing the server time when this
- # object was created. It is not guaranteed to be set in happens-before order
- # across separate operations. Clients may not set this value. It is
- # represented in RFC3339 form and is in UTC.
- #
- # Populated by the system.
- # Read-only.
- # Null for lists.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
- "labels": { # (Optional)
- #
- # Map of string keys and values that can be used to organize and categorize
- # (scope and select) objects. May match selectors of replication controllers
- # and routes.
- # More info: http://kubernetes.io/docs/user-guide/labels
- "a_key": "A String",
- },
- "generation": 42, # (Optional)
- #
- # A sequence number representing a specific generation of the desired state.
- # Populated by the system. Read-only.
- "resourceVersion": "A String", # (Optional)
- #
- # An opaque value that represents the internal version of this object that
- # can be used by clients to determine when objects have changed. May be used
- # for optimistic concurrency, change detection, and the watch operation on a
- # resource or set of resources. Clients must treat these values as opaque and
- # passed unmodified back to the server. They may only be valid for a
- # particular resource or set of resources.
- #
- # Populated by the system.
- # Read-only.
- # Value must be treated as opaque by clients and .
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- "selfLink": "A String", # (Optional)
- #
- # SelfLink is a URL representing this object.
- # Populated by the system.
- # Read-only.
- # string selfLink = 4;
- "uid": "A String", # (Optional)
- #
- # UID is the unique in time and space value for this object. It is typically
- # generated by the server on successful creation of a resource and is not
- # allowed to change on PUT operations.
- #
- # Populated by the system.
- # Read-only.
- # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- "namespace": "A String", # Namespace defines the space within each name must be unique, within a
- # Cloud Run region. In Cloud Run the namespace must be equal to either the
- # project ID or project number.
"annotations": { # (Optional)
#
# Annotations is an unstructured key value map stored with a resource that
@@ -778,8 +603,6 @@
{ # OwnerReference contains enough information to let you identify an owning
# object. Currently, an owning object must be in the same namespace, so there
# is no namespace field.
- "uid": "A String", # UID of the referent.
- # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
"controller": True or False, # If true, this reference points to the managing controller.
# +optional
"kind": "A String", # Kind of the referent.
@@ -795,12 +618,189 @@
"apiVersion": "A String", # API version of the referent.
"name": "A String", # Name of the referent.
# More info: http://kubernetes.io/docs/user-guide/identifiers#names
+ "uid": "A String", # UID of the referent.
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+ },
+ ],
+ "creationTimestamp": "A String", # (Optional)
+ #
+ # CreationTimestamp is a timestamp representing the server time when this
+ # object was created. It is not guaranteed to be set in happens-before order
+ # across separate operations. Clients may not set this value. It is
+ # represented in RFC3339 form and is in UTC.
+ #
+ # Populated by the system.
+ # Read-only.
+ # Null for lists.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+ "labels": { # (Optional)
+ #
+ # Map of string keys and values that can be used to organize and categorize
+ # (scope and select) objects. May match selectors of replication controllers
+ # and routes.
+ # More info: http://kubernetes.io/docs/user-guide/labels
+ "a_key": "A String",
+ },
+ "generation": 42, # (Optional)
+ #
+ # A sequence number representing a specific generation of the desired state.
+ # Populated by the system. Read-only.
+ "resourceVersion": "A String", # (Optional)
+ #
+ # An opaque value that represents the internal version of this object that
+ # can be used by clients to determine when objects have changed. May be used
+ # for optimistic concurrency, change detection, and the watch operation on a
+ # resource or set of resources. Clients must treat these values as opaque and
+ # passed unmodified back to the server. They may only be valid for a
+ # particular resource or set of resources.
+ #
+ # Populated by the system.
+ # Read-only.
+ # Value must be treated as opaque by clients and .
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
+ "selfLink": "A String", # (Optional)
+ #
+ # SelfLink is a URL representing this object.
+ # Populated by the system.
+ # Read-only.
+ # string selfLink = 4;
+ "uid": "A String", # (Optional)
+ #
+ # UID is the unique in time and space value for this object. It is typically
+ # generated by the server on successful creation of a resource and is not
+ # allowed to change on PUT operations.
+ #
+ # Populated by the system.
+ # Read-only.
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+ "namespace": "A String", # Namespace defines the space within each name must be unique, within a
+ # Cloud Run region. In Cloud Run the namespace must be equal to either the
+ # project ID or project number.
+ },
+ "status": { # RouteStatus communicates the observed state of the Route (from the # Status communicates the observed state of the Route (from the controller).
+ # controller).
+ "conditions": [ # Conditions communicates information about ongoing/complete
+ # reconciliation processes that bring the "spec" inline with the observed
+ # state of the world.
+ { # Condition defines a generic condition for a Resource
+ "message": "A String", # Optional. Human readable message indicating details about the current status.
+ "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
+ "status": "A String", # Status of the condition, one of True, False, Unknown.
+ "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info
+ "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.
+ "type": "A String", # type is used to communicate the status of the reconciliation process.
+ # See also:
+ # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting
+ # Types common to all resources include:
+ # * "Ready": True when the Resource is ready.
+ },
+ ],
+ "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Route that
+ # was last processed by the controller.
+ #
+ # Clients polling for completed reconciliation should poll until
+ # observedGeneration = metadata.generation and the Ready condition's status
+ # is True or False.
+ #
+ # Note that providing a trafficTarget that only has a configurationName will
+ # result in a Route that does not increment either its metadata.generation or
+ # its observedGeneration, as new "latest ready" revisions from the
+ # Configuration are processed without an update to the Route's spec.
+ "address": { # Information for connecting over HTTP(s). # Similar to url, information on where the service is available on HTTP.
+ "url": "A String",
+ },
+ "url": "A String", # URL holds the url that will distribute traffic over the provided traffic
+ # targets. It generally has the form:
+ # https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app
+ "traffic": [ # Traffic holds the configured traffic distribution.
+ # These entries will always contain RevisionName references.
+ # When ConfigurationName appears in the spec, this will hold the
+ # LatestReadyRevisionName that we last observed.
+ { # TrafficTarget holds a single entry of the routing table for a Route.
+ "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of
+ # traffic. This is mutually exclusive with ConfigurationName.
+ #
+ # Providing RevisionName in spec is not currently supported by Cloud Run.
+ "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest
+ # ready Revision of the Configuration should be used for this traffic
+ # target. When provided LatestRevision must be true if RevisionName is
+ # empty; it must be false when RevisionName is non-empty.
+ #
+ # +optional
+ "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing
+ # this target exclusively.
+ #
+ # Not currently supported in Cloud Run.
+ # +optional
+ "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL
+ # is displayed in status, and is disallowed on spec. URL must contain a
+ # scheme (e.g. http://) and a hostname, but may not contain anything else
+ # (e.g. basic auth, url path, etc.
+ #
+ # Not currently supported in Cloud Run.
+ "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will
+ # send this portion of traffic. When the "status.latestReadyRevisionName"
+ # of the referenced configuration changes, we will automatically migrate
+ # traffic from the prior "latest ready" revision to the new one. This field
+ # is never set in Route's status, only its spec. This is mutually exclusive
+ # with RevisionName.
+ #
+ # Cloud Run currently supports a single ConfigurationName.
+ "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.
+ # This defaults to zero if unspecified.
+ #
+ # Cloud Run currently requires 100 percent for a single ConfigurationName
+ # TrafficTarget entry.
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
+ "spec": { # RouteSpec holds the desired state of the Route (from the client). # Spec holds the desired state of the Route (from the client).
+ "traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative
+ # Revisions and Configurations.
+ # Cloud Run currently supports a single configurationName.
+ { # TrafficTarget holds a single entry of the routing table for a Route.
+ "revisionName": "A String", # RevisionName of a specific revision to which to send this portion of
+ # traffic. This is mutually exclusive with ConfigurationName.
+ #
+ # Providing RevisionName in spec is not currently supported by Cloud Run.
+ "latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest
+ # ready Revision of the Configuration should be used for this traffic
+ # target. When provided LatestRevision must be true if RevisionName is
+ # empty; it must be false when RevisionName is non-empty.
+ #
+ # +optional
+ "tag": "A String", # Tag is optionally used to expose a dedicated url for referencing
+ # this target exclusively.
+ #
+ # Not currently supported in Cloud Run.
+ # +optional
+ "url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL
+ # is displayed in status, and is disallowed on spec. URL must contain a
+ # scheme (e.g. http://) and a hostname, but may not contain anything else
+ # (e.g. basic auth, url path, etc.
+ #
+ # Not currently supported in Cloud Run.
+ "configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will
+ # send this portion of traffic. When the "status.latestReadyRevisionName"
+ # of the referenced configuration changes, we will automatically migrate
+ # traffic from the prior "latest ready" revision to the new one. This field
+ # is never set in Route's status, only its spec. This is mutually exclusive
+ # with RevisionName.
+ #
+ # Cloud Run currently supports a single ConfigurationName.
+ "percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.
+ # This defaults to zero if unspecified.
+ #
+ # Cloud Run currently requires 100 percent for a single ConfigurationName
+ # TrafficTarget entry.
},
],
},
},
],
- "apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
}</pre>
</div>