docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/run_v1alpha1.namespaces.domainmappings.html b/docs/dyn/run_v1alpha1.namespaces.domainmappings.html
index 0334e12..2a7f6af 100644
--- a/docs/dyn/run_v1alpha1.namespaces.domainmappings.html
+++ b/docs/dyn/run_v1alpha1.namespaces.domainmappings.html
@@ -78,13 +78,13 @@
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new domain mapping.</p>
<p class="toc_element">
- <code><a href="#delete">delete(name, orphanDependents=None, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, orphanDependents=None, x__xgafv=None)</a></code></p>
<p class="firstline">Rpc to delete a domain mapping.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Rpc to get information about a domain mapping.</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, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, continue=None, limit=None, watch=None, x__xgafv=None)</a></code></p>
<p class="firstline">Rpc to list domain mappings.</p>
<h3>Method Details</h3>
<div class="method">
@@ -98,15 +98,54 @@
The object takes the form of:
{ # Resource to hold the state and status of a user's domain mapping.
+ "status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
+ "mappedRouteName": "A String", # The name of the route that the mapping currently points to.
+ "conditions": [ # Array of observed DomainMappingConditions, indicating the current state
+ # of the DomainMapping.
+ { # DomainMappingCondition contains state information for a DomainMapping.
+ "message": "A String", # Human readable message indicating details about the current status.
+ # +optional
+ "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+ # +optional
+ "status": "A String", # Status of the condition, one of True, False, Unknown.
+ "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+ # +optional
+ "reason": "A String", # One-word CamelCase reason for the condition's current status.
+ # +optional
+ "type": "A String", # Type of domain mapping condition.
+ },
+ ],
+ "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping 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.
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These
+ # records must be added to the domain's DNS configuration in order to
+ # serve the application via this domain mapping.
+ { # A DNS resource record.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for
+ # `CNAME` records. Example: 'www'.
+ "type": "A String", # Resource record type. Example: `AAAA`.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035
+ # (section 5) and RFC 1034 (section 3.6.1).
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1alpha1".
+ "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
+ "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.
+ # It is recommended that the user leaves this empty to receive an error
+ # warning about a potential conflict and only set it once the respective UI
+ # has given such a warning.
+ "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.
+ # The route must exist.
+ "certificateMode": "A String", # The mode of the certificate.
+ },
"kind": "A String", # The kind of resource, in this case "DomainMapping".
"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.
# all objects users must create.
- "annotations": { # Annotations is an unstructured key value map stored with a resource that
- # may be set by external tools to store and retrieve arbitrary metadata. They
- # are not queryable and should be preserved when modifying objects. More
- # info: http://kubernetes.io/docs/user-guide/annotations +optional
- "a_key": "A String",
- },
"generateName": "A String", # Not currently supported by Cloud Run.
#
# GenerateName is an optional prefix, used by the server, to generate a
@@ -135,17 +174,17 @@
# for creation idempotence and configuration definition. Cannot be updated.
# More info: http://kubernetes.io/docs/user-guide/identifiers#names
# +optional
+ "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.
+ #
+ # Number of seconds allowed for this object to gracefully terminate before
+ # it will be removed from the system. Only set when deletionTimestamp is also
+ # set. May only be shortened. Read-only. +optional
"clusterName": "A String", # Not currently supported by Cloud Run.
#
# The name of the cluster which the object belongs to.
# This is used to distinguish resources with same name and namespace in
# different clusters. This field is not set anywhere right now and apiserver
# is going to ignore it if set in create or update request. +optional
- "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.
- #
- # Number of seconds allowed for this object to gracefully terminate before
- # it will be removed from the system. Only set when deletionTimestamp is also
- # set. May only be shortened. Read-only. +optional
"finalizers": [ # Not currently supported by Cloud Run.
#
# Must be empty before the object is deleted from the registry. Each entry
@@ -185,11 +224,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.
- "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
"controller": True or False, # If true, this reference points to the managing controller.
# +optional
"kind": "A String", # Kind of the referent.
@@ -202,6 +236,11 @@
# To set this field, a user needs "delete" permission of the owner,
# otherwise 422 (Unprocessable Entity) will be returned.
# +optional
+ "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", # CreationTimestamp is a timestamp representing the server time when this
@@ -238,6 +277,11 @@
# More info:
# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
# +optional
+ "selfLink": "A String", # SelfLink is a URL representing this object.
+ # Populated by the system.
+ # Read-only.
+ # +optional
+ # string selfLink = 4;
"uid": "A String", # 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.
@@ -246,59 +290,15 @@
# Read-only.
# More info: http://kubernetes.io/docs/user-guide/identifiers#uids
# +optional
- "selfLink": "A String", # SelfLink is a URL representing this object.
- # Populated by the system.
- # Read-only.
- # +optional
- # string selfLink = 4;
"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": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
- "resourceRecords": [ # The resource records required to configure this domain mapping. These
- # records must be added to the domain's DNS configuration in order to
- # serve the application via this domain mapping.
- { # A DNS resource record.
- "name": "A String", # Relative name of the object affected by this record. Only applicable for
- # `CNAME` records. Example: 'www'.
- "type": "A String", # Resource record type. Example: `AAAA`.
- "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035
- # (section 5) and RFC 1034 (section 3.6.1).
- },
- ],
- "mappedRouteName": "A String", # The name of the route that the mapping currently points to.
- "conditions": [ # Array of observed DomainMappingConditions, indicating the current state
- # of the DomainMapping.
- { # DomainMappingCondition contains state information for a DomainMapping.
- "message": "A String", # Human readable message indicating details about the current status.
- # +optional
- "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
- # +optional
- "status": "A String", # Status of the condition, one of True, False, Unknown.
- "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
- # +optional
- "reason": "A String", # One-word CamelCase reason for the condition's current status.
- # +optional
- "type": "A String", # Type of domain mapping condition.
- },
- ],
- "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping 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.
- },
- "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1alpha1".
- "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
- "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.
- # It is recommended that the user leaves this empty to receive an error
- # warning about a potential conflict and only set it once the respective UI
- # has given such a warning.
- "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.
- # The route must exist.
- "certificateMode": "A String", # The mode of the certificate.
+ "annotations": { # Annotations is an unstructured key value map stored with a resource that
+ # may be set by external tools to store and retrieve arbitrary metadata. They
+ # are not queryable and should be preserved when modifying objects. More
+ # info: http://kubernetes.io/docs/user-guide/annotations +optional
+ "a_key": "A String",
+ },
},
}
@@ -311,15 +311,54 @@
An object of the form:
{ # Resource to hold the state and status of a user's domain mapping.
+ "status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
+ "mappedRouteName": "A String", # The name of the route that the mapping currently points to.
+ "conditions": [ # Array of observed DomainMappingConditions, indicating the current state
+ # of the DomainMapping.
+ { # DomainMappingCondition contains state information for a DomainMapping.
+ "message": "A String", # Human readable message indicating details about the current status.
+ # +optional
+ "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+ # +optional
+ "status": "A String", # Status of the condition, one of True, False, Unknown.
+ "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+ # +optional
+ "reason": "A String", # One-word CamelCase reason for the condition's current status.
+ # +optional
+ "type": "A String", # Type of domain mapping condition.
+ },
+ ],
+ "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping 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.
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These
+ # records must be added to the domain's DNS configuration in order to
+ # serve the application via this domain mapping.
+ { # A DNS resource record.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for
+ # `CNAME` records. Example: 'www'.
+ "type": "A String", # Resource record type. Example: `AAAA`.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035
+ # (section 5) and RFC 1034 (section 3.6.1).
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1alpha1".
+ "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
+ "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.
+ # It is recommended that the user leaves this empty to receive an error
+ # warning about a potential conflict and only set it once the respective UI
+ # has given such a warning.
+ "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.
+ # The route must exist.
+ "certificateMode": "A String", # The mode of the certificate.
+ },
"kind": "A String", # The kind of resource, in this case "DomainMapping".
"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.
# all objects users must create.
- "annotations": { # Annotations is an unstructured key value map stored with a resource that
- # may be set by external tools to store and retrieve arbitrary metadata. They
- # are not queryable and should be preserved when modifying objects. More
- # info: http://kubernetes.io/docs/user-guide/annotations +optional
- "a_key": "A String",
- },
"generateName": "A String", # Not currently supported by Cloud Run.
#
# GenerateName is an optional prefix, used by the server, to generate a
@@ -348,17 +387,17 @@
# for creation idempotence and configuration definition. Cannot be updated.
# More info: http://kubernetes.io/docs/user-guide/identifiers#names
# +optional
+ "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.
+ #
+ # Number of seconds allowed for this object to gracefully terminate before
+ # it will be removed from the system. Only set when deletionTimestamp is also
+ # set. May only be shortened. Read-only. +optional
"clusterName": "A String", # Not currently supported by Cloud Run.
#
# The name of the cluster which the object belongs to.
# This is used to distinguish resources with same name and namespace in
# different clusters. This field is not set anywhere right now and apiserver
# is going to ignore it if set in create or update request. +optional
- "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.
- #
- # Number of seconds allowed for this object to gracefully terminate before
- # it will be removed from the system. Only set when deletionTimestamp is also
- # set. May only be shortened. Read-only. +optional
"finalizers": [ # Not currently supported by Cloud Run.
#
# Must be empty before the object is deleted from the registry. Each entry
@@ -398,11 +437,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.
- "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
"controller": True or False, # If true, this reference points to the managing controller.
# +optional
"kind": "A String", # Kind of the referent.
@@ -415,6 +449,11 @@
# To set this field, a user needs "delete" permission of the owner,
# otherwise 422 (Unprocessable Entity) will be returned.
# +optional
+ "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", # CreationTimestamp is a timestamp representing the server time when this
@@ -451,6 +490,11 @@
# More info:
# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
# +optional
+ "selfLink": "A String", # SelfLink is a URL representing this object.
+ # Populated by the system.
+ # Read-only.
+ # +optional
+ # string selfLink = 4;
"uid": "A String", # 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.
@@ -459,81 +503,37 @@
# Read-only.
# More info: http://kubernetes.io/docs/user-guide/identifiers#uids
# +optional
- "selfLink": "A String", # SelfLink is a URL representing this object.
- # Populated by the system.
- # Read-only.
- # +optional
- # string selfLink = 4;
"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": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
- "resourceRecords": [ # The resource records required to configure this domain mapping. These
- # records must be added to the domain's DNS configuration in order to
- # serve the application via this domain mapping.
- { # A DNS resource record.
- "name": "A String", # Relative name of the object affected by this record. Only applicable for
- # `CNAME` records. Example: 'www'.
- "type": "A String", # Resource record type. Example: `AAAA`.
- "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035
- # (section 5) and RFC 1034 (section 3.6.1).
- },
- ],
- "mappedRouteName": "A String", # The name of the route that the mapping currently points to.
- "conditions": [ # Array of observed DomainMappingConditions, indicating the current state
- # of the DomainMapping.
- { # DomainMappingCondition contains state information for a DomainMapping.
- "message": "A String", # Human readable message indicating details about the current status.
- # +optional
- "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
- # +optional
- "status": "A String", # Status of the condition, one of True, False, Unknown.
- "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
- # +optional
- "reason": "A String", # One-word CamelCase reason for the condition's current status.
- # +optional
- "type": "A String", # Type of domain mapping condition.
- },
- ],
- "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping 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.
- },
- "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1alpha1".
- "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
- "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.
- # It is recommended that the user leaves this empty to receive an error
- # warning about a potential conflict and only set it once the respective UI
- # has given such a warning.
- "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.
- # The route must exist.
- "certificateMode": "A String", # The mode of the certificate.
+ "annotations": { # Annotations is an unstructured key value map stored with a resource that
+ # may be set by external tools to store and retrieve arbitrary metadata. They
+ # are not queryable and should be preserved when modifying objects. More
+ # info: http://kubernetes.io/docs/user-guide/annotations +optional
+ "a_key": "A String",
+ },
},
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(name, orphanDependents=None, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, orphanDependents=None, x__xgafv=None)</code>
<pre>Rpc to delete a domain mapping.
Args:
name: string, The name of the domain mapping being deleted. If needed, replace
{namespace_id} with the project ID. (required)
- orphanDependents: boolean, Deprecated.
-Specifies the cascade behavior on delete.
-Cloud Run only supports cascading behavior, so this must be false.
-This attribute is deprecated, and is now replaced with PropagationPolicy
-See https://github.com/kubernetes/kubernetes/issues/46659 for more info.
apiVersion: string, Cloud Run currently ignores this parameter.
propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores
this setting, and deletes in the background. Please see
kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for
more information.
kind: string, Cloud Run currently ignores this parameter.
+ orphanDependents: boolean, Deprecated.
+Specifies the cascade behavior on delete.
+Cloud Run only supports cascading behavior, so this must be false.
+This attribute is deprecated, and is now replaced with PropagationPolicy
+See https://github.com/kubernetes/kubernetes/issues/46659 for more info.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -570,15 +570,54 @@
An object of the form:
{ # Resource to hold the state and status of a user's domain mapping.
+ "status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
+ "mappedRouteName": "A String", # The name of the route that the mapping currently points to.
+ "conditions": [ # Array of observed DomainMappingConditions, indicating the current state
+ # of the DomainMapping.
+ { # DomainMappingCondition contains state information for a DomainMapping.
+ "message": "A String", # Human readable message indicating details about the current status.
+ # +optional
+ "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+ # +optional
+ "status": "A String", # Status of the condition, one of True, False, Unknown.
+ "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+ # +optional
+ "reason": "A String", # One-word CamelCase reason for the condition's current status.
+ # +optional
+ "type": "A String", # Type of domain mapping condition.
+ },
+ ],
+ "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping 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.
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These
+ # records must be added to the domain's DNS configuration in order to
+ # serve the application via this domain mapping.
+ { # A DNS resource record.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for
+ # `CNAME` records. Example: 'www'.
+ "type": "A String", # Resource record type. Example: `AAAA`.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035
+ # (section 5) and RFC 1034 (section 3.6.1).
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1alpha1".
+ "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
+ "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.
+ # It is recommended that the user leaves this empty to receive an error
+ # warning about a potential conflict and only set it once the respective UI
+ # has given such a warning.
+ "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.
+ # The route must exist.
+ "certificateMode": "A String", # The mode of the certificate.
+ },
"kind": "A String", # The kind of resource, in this case "DomainMapping".
"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.
# all objects users must create.
- "annotations": { # Annotations is an unstructured key value map stored with a resource that
- # may be set by external tools to store and retrieve arbitrary metadata. They
- # are not queryable and should be preserved when modifying objects. More
- # info: http://kubernetes.io/docs/user-guide/annotations +optional
- "a_key": "A String",
- },
"generateName": "A String", # Not currently supported by Cloud Run.
#
# GenerateName is an optional prefix, used by the server, to generate a
@@ -607,17 +646,17 @@
# for creation idempotence and configuration definition. Cannot be updated.
# More info: http://kubernetes.io/docs/user-guide/identifiers#names
# +optional
+ "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.
+ #
+ # Number of seconds allowed for this object to gracefully terminate before
+ # it will be removed from the system. Only set when deletionTimestamp is also
+ # set. May only be shortened. Read-only. +optional
"clusterName": "A String", # Not currently supported by Cloud Run.
#
# The name of the cluster which the object belongs to.
# This is used to distinguish resources with same name and namespace in
# different clusters. This field is not set anywhere right now and apiserver
# is going to ignore it if set in create or update request. +optional
- "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.
- #
- # Number of seconds allowed for this object to gracefully terminate before
- # it will be removed from the system. Only set when deletionTimestamp is also
- # set. May only be shortened. Read-only. +optional
"finalizers": [ # Not currently supported by Cloud Run.
#
# Must be empty before the object is deleted from the registry. Each entry
@@ -657,11 +696,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.
- "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
"controller": True or False, # If true, this reference points to the managing controller.
# +optional
"kind": "A String", # Kind of the referent.
@@ -674,6 +708,11 @@
# To set this field, a user needs "delete" permission of the owner,
# otherwise 422 (Unprocessable Entity) will be returned.
# +optional
+ "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", # CreationTimestamp is a timestamp representing the server time when this
@@ -710,6 +749,11 @@
# More info:
# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
# +optional
+ "selfLink": "A String", # SelfLink is a URL representing this object.
+ # Populated by the system.
+ # Read-only.
+ # +optional
+ # string selfLink = 4;
"uid": "A String", # 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.
@@ -718,65 +762,21 @@
# Read-only.
# More info: http://kubernetes.io/docs/user-guide/identifiers#uids
# +optional
- "selfLink": "A String", # SelfLink is a URL representing this object.
- # Populated by the system.
- # Read-only.
- # +optional
- # string selfLink = 4;
"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": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
- "resourceRecords": [ # The resource records required to configure this domain mapping. These
- # records must be added to the domain's DNS configuration in order to
- # serve the application via this domain mapping.
- { # A DNS resource record.
- "name": "A String", # Relative name of the object affected by this record. Only applicable for
- # `CNAME` records. Example: 'www'.
- "type": "A String", # Resource record type. Example: `AAAA`.
- "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035
- # (section 5) and RFC 1034 (section 3.6.1).
- },
- ],
- "mappedRouteName": "A String", # The name of the route that the mapping currently points to.
- "conditions": [ # Array of observed DomainMappingConditions, indicating the current state
- # of the DomainMapping.
- { # DomainMappingCondition contains state information for a DomainMapping.
- "message": "A String", # Human readable message indicating details about the current status.
- # +optional
- "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
- # +optional
- "status": "A String", # Status of the condition, one of True, False, Unknown.
- "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
- # +optional
- "reason": "A String", # One-word CamelCase reason for the condition's current status.
- # +optional
- "type": "A String", # Type of domain mapping condition.
- },
- ],
- "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping 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.
- },
- "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1alpha1".
- "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
- "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.
- # It is recommended that the user leaves this empty to receive an error
- # warning about a potential conflict and only set it once the respective UI
- # has given such a warning.
- "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.
- # The route must exist.
- "certificateMode": "A String", # The mode of the certificate.
+ "annotations": { # Annotations is an unstructured key value map stored with a resource that
+ # may be set by external tools to store and retrieve arbitrary metadata. They
+ # are not queryable and should be preserved when modifying objects. More
+ # info: http://kubernetes.io/docs/user-guide/annotations +optional
+ "a_key": "A String",
+ },
},
}</pre>
</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, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, continue=None, limit=None, watch=None, x__xgafv=None)</code>
<pre>Rpc to list domain mappings.
Args:
@@ -784,12 +784,12 @@
listed. (required)
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
-start. Not currently used by Cloud Run.
- includeUninitialized: boolean, Not currently used by Cloud Run.
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.
+ includeUninitialized: boolean, Not currently used by Cloud Run.
+ resourceVersion: string, The baseline resource version from which the list or watch operation should
+start. 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.
@@ -834,15 +834,54 @@
},
"items": [ # List of DomainMappings.
{ # Resource to hold the state and status of a user's domain mapping.
+ "status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
+ "mappedRouteName": "A String", # The name of the route that the mapping currently points to.
+ "conditions": [ # Array of observed DomainMappingConditions, indicating the current state
+ # of the DomainMapping.
+ { # DomainMappingCondition contains state information for a DomainMapping.
+ "message": "A String", # Human readable message indicating details about the current status.
+ # +optional
+ "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+ # +optional
+ "status": "A String", # Status of the condition, one of True, False, Unknown.
+ "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+ # +optional
+ "reason": "A String", # One-word CamelCase reason for the condition's current status.
+ # +optional
+ "type": "A String", # Type of domain mapping condition.
+ },
+ ],
+ "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping 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.
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These
+ # records must be added to the domain's DNS configuration in order to
+ # serve the application via this domain mapping.
+ { # A DNS resource record.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for
+ # `CNAME` records. Example: 'www'.
+ "type": "A String", # Resource record type. Example: `AAAA`.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035
+ # (section 5) and RFC 1034 (section 3.6.1).
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1alpha1".
+ "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
+ "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.
+ # It is recommended that the user leaves this empty to receive an error
+ # warning about a potential conflict and only set it once the respective UI
+ # has given such a warning.
+ "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.
+ # The route must exist.
+ "certificateMode": "A String", # The mode of the certificate.
+ },
"kind": "A String", # The kind of resource, in this case "DomainMapping".
"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.
# all objects users must create.
- "annotations": { # Annotations is an unstructured key value map stored with a resource that
- # may be set by external tools to store and retrieve arbitrary metadata. They
- # are not queryable and should be preserved when modifying objects. More
- # info: http://kubernetes.io/docs/user-guide/annotations +optional
- "a_key": "A String",
- },
"generateName": "A String", # Not currently supported by Cloud Run.
#
# GenerateName is an optional prefix, used by the server, to generate a
@@ -871,17 +910,17 @@
# for creation idempotence and configuration definition. Cannot be updated.
# More info: http://kubernetes.io/docs/user-guide/identifiers#names
# +optional
+ "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.
+ #
+ # Number of seconds allowed for this object to gracefully terminate before
+ # it will be removed from the system. Only set when deletionTimestamp is also
+ # set. May only be shortened. Read-only. +optional
"clusterName": "A String", # Not currently supported by Cloud Run.
#
# The name of the cluster which the object belongs to.
# This is used to distinguish resources with same name and namespace in
# different clusters. This field is not set anywhere right now and apiserver
# is going to ignore it if set in create or update request. +optional
- "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.
- #
- # Number of seconds allowed for this object to gracefully terminate before
- # it will be removed from the system. Only set when deletionTimestamp is also
- # set. May only be shortened. Read-only. +optional
"finalizers": [ # Not currently supported by Cloud Run.
#
# Must be empty before the object is deleted from the registry. Each entry
@@ -921,11 +960,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.
- "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
"controller": True or False, # If true, this reference points to the managing controller.
# +optional
"kind": "A String", # Kind of the referent.
@@ -938,6 +972,11 @@
# To set this field, a user needs "delete" permission of the owner,
# otherwise 422 (Unprocessable Entity) will be returned.
# +optional
+ "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", # CreationTimestamp is a timestamp representing the server time when this
@@ -974,6 +1013,11 @@
# More info:
# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
# +optional
+ "selfLink": "A String", # SelfLink is a URL representing this object.
+ # Populated by the system.
+ # Read-only.
+ # +optional
+ # string selfLink = 4;
"uid": "A String", # 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.
@@ -982,59 +1026,15 @@
# Read-only.
# More info: http://kubernetes.io/docs/user-guide/identifiers#uids
# +optional
- "selfLink": "A String", # SelfLink is a URL representing this object.
- # Populated by the system.
- # Read-only.
- # +optional
- # string selfLink = 4;
"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": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
- "resourceRecords": [ # The resource records required to configure this domain mapping. These
- # records must be added to the domain's DNS configuration in order to
- # serve the application via this domain mapping.
- { # A DNS resource record.
- "name": "A String", # Relative name of the object affected by this record. Only applicable for
- # `CNAME` records. Example: 'www'.
- "type": "A String", # Resource record type. Example: `AAAA`.
- "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035
- # (section 5) and RFC 1034 (section 3.6.1).
- },
- ],
- "mappedRouteName": "A String", # The name of the route that the mapping currently points to.
- "conditions": [ # Array of observed DomainMappingConditions, indicating the current state
- # of the DomainMapping.
- { # DomainMappingCondition contains state information for a DomainMapping.
- "message": "A String", # Human readable message indicating details about the current status.
- # +optional
- "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
- # +optional
- "status": "A String", # Status of the condition, one of True, False, Unknown.
- "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
- # +optional
- "reason": "A String", # One-word CamelCase reason for the condition's current status.
- # +optional
- "type": "A String", # Type of domain mapping condition.
- },
- ],
- "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping 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.
- },
- "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1alpha1".
- "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
- "forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.
- # It is recommended that the user leaves this empty to receive an error
- # warning about a potential conflict and only set it once the respective UI
- # has given such a warning.
- "routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.
- # The route must exist.
- "certificateMode": "A String", # The mode of the certificate.
+ "annotations": { # Annotations is an unstructured key value map stored with a resource that
+ # may be set by external tools to store and retrieve arbitrary metadata. They
+ # are not queryable and should be preserved when modifying objects. More
+ # info: http://kubernetes.io/docs/user-guide/annotations +optional
+ "a_key": "A String",
+ },
},
},
],