docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/run_v1.namespaces.domainmappings.html b/docs/dyn/run_v1.namespaces.domainmappings.html
new file mode 100644
index 0000000..8568031
--- /dev/null
+++ b/docs/dyn/run_v1.namespaces.domainmappings.html
@@ -0,0 +1,1256 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="run_v1.html">Cloud Run API</a> . <a href="run_v1.namespaces.html">namespaces</a> . <a href="run_v1.namespaces.domainmappings.html">domainmappings</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Create a new domain mapping.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Delete a domain mapping.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Get information about a domain mapping.</p>
+<p class="toc_element">
+ <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">List domain mappings.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
+ <pre>Create a new domain mapping.
+
+Args:
+ parent: string, The namespace in which the domain mapping should be created.
+For Cloud Run (fully managed), replace {namespace_id} with the project ID
+or number. (required)
+ body: object, The request body.
+ 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.
+ { # 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 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.
+ "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).
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for
+ # `CNAME` records. Example: 'www'.
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
+ "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
+ "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.
+ "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.
+ },
+ "kind": "A String", # The kind of resource, in this case "DomainMapping".
+ "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate.
+ # 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
+ # 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
+ "a_key": "A String",
+ },
+ "generateName": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # GenerateName is an optional prefix, used by the server, to generate a
+ # unique name ONLY IF the Name field has not been provided. If this field is
+ # used, the name returned to the client will be different than the name
+ # passed. This value will also be combined with a unique suffix. The provided
+ # value has the same validation rules as the Name field, and may be truncated
+ # by the length of the suffix required to make the value unique on the
+ # server.
+ #
+ # If this field is specified and the generated name exists, the server will
+ # NOT return a 409 - instead, it will either return 201 Created or 500 with
+ # Reason ServerTimeout indicating a unique name could not be found in the
+ # time allotted, and the client should retry (optionally after the time
+ # indicated in the Retry-After header).
+ #
+ # Applied only if Name is not specified.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
+ # string generateName = 2;
+ "name": "A String", # Name must be unique within a namespace, within a Cloud Run region.
+ # Is required when creating
+ # resources, although some resources may allow a client to request the
+ # generation of an appropriate name automatically. Name is primarily intended
+ # for creation idempotence and configuration definition. Cannot be updated.
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#names
+ # +optional
+ "deletionGracePeriodSeconds": 42, # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # 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.
+ "clusterName": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # 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.
+ "finalizers": [ # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # Must be empty before the object is deleted from the registry. Each entry
+ # is an identifier for the responsible component that will remove the entry
+ # from the list. If the deletionTimestamp of the object is non-nil, entries
+ # in this list can only be removed.
+ # +patchStrategy=merge
+ "A String",
+ ],
+ "deletionTimestamp": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # DeletionTimestamp is RFC 3339 date and time at which this resource will be
+ # deleted. This field is set by the server when a graceful deletion is
+ # requested by the user, and is not directly settable by a client. The
+ # resource is expected to be deleted (no longer visible from resource lists,
+ # and not reachable by name) after the time in this field, once the
+ # finalizers list is empty. As long as the finalizers list contains items,
+ # deletion is blocked. Once the deletionTimestamp is set, this value may not
+ # be unset or be set further into the future, although it may be shortened or
+ # the resource may be deleted prior to this time. For example, a user may
+ # request that a pod is deleted in 30 seconds. The Kubelet will react by
+ # sending a graceful termination signal to the containers in the pod. After
+ # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
+ # to the container and after cleanup, remove the pod from the API. In the
+ # presence of network partitions, this object may still exist after this
+ # timestamp, until an administrator or automated process can determine the
+ # resource is fully terminated.
+ # If not set, graceful deletion of the object has not been requested.
+ #
+ # Populated by the system when a graceful deletion is requested.
+ # Read-only.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+ "ownerReferences": [ # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # List of objects that own this object. If ALL objects in the list have
+ # been deleted, this object will be garbage collected.
+ { # 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.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then
+ # the owner cannot be deleted from the key-value store until this
+ # reference is removed.
+ # Defaults to false.
+ # 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
+ },
+ ],
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ 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.
+ { # 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 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.
+ "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).
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for
+ # `CNAME` records. Example: 'www'.
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
+ "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
+ "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.
+ "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.
+ },
+ "kind": "A String", # The kind of resource, in this case "DomainMapping".
+ "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate.
+ # 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
+ # 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
+ "a_key": "A String",
+ },
+ "generateName": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # GenerateName is an optional prefix, used by the server, to generate a
+ # unique name ONLY IF the Name field has not been provided. If this field is
+ # used, the name returned to the client will be different than the name
+ # passed. This value will also be combined with a unique suffix. The provided
+ # value has the same validation rules as the Name field, and may be truncated
+ # by the length of the suffix required to make the value unique on the
+ # server.
+ #
+ # If this field is specified and the generated name exists, the server will
+ # NOT return a 409 - instead, it will either return 201 Created or 500 with
+ # Reason ServerTimeout indicating a unique name could not be found in the
+ # time allotted, and the client should retry (optionally after the time
+ # indicated in the Retry-After header).
+ #
+ # Applied only if Name is not specified.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
+ # string generateName = 2;
+ "name": "A String", # Name must be unique within a namespace, within a Cloud Run region.
+ # Is required when creating
+ # resources, although some resources may allow a client to request the
+ # generation of an appropriate name automatically. Name is primarily intended
+ # for creation idempotence and configuration definition. Cannot be updated.
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#names
+ # +optional
+ "deletionGracePeriodSeconds": 42, # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # 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.
+ "clusterName": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # 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.
+ "finalizers": [ # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # Must be empty before the object is deleted from the registry. Each entry
+ # is an identifier for the responsible component that will remove the entry
+ # from the list. If the deletionTimestamp of the object is non-nil, entries
+ # in this list can only be removed.
+ # +patchStrategy=merge
+ "A String",
+ ],
+ "deletionTimestamp": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # DeletionTimestamp is RFC 3339 date and time at which this resource will be
+ # deleted. This field is set by the server when a graceful deletion is
+ # requested by the user, and is not directly settable by a client. The
+ # resource is expected to be deleted (no longer visible from resource lists,
+ # and not reachable by name) after the time in this field, once the
+ # finalizers list is empty. As long as the finalizers list contains items,
+ # deletion is blocked. Once the deletionTimestamp is set, this value may not
+ # be unset or be set further into the future, although it may be shortened or
+ # the resource may be deleted prior to this time. For example, a user may
+ # request that a pod is deleted in 30 seconds. The Kubelet will react by
+ # sending a graceful termination signal to the containers in the pod. After
+ # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
+ # to the container and after cleanup, remove the pod from the API. In the
+ # presence of network partitions, this object may still exist after this
+ # timestamp, until an administrator or automated process can determine the
+ # resource is fully terminated.
+ # If not set, graceful deletion of the object has not been requested.
+ #
+ # Populated by the system when a graceful deletion is requested.
+ # Read-only.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+ "ownerReferences": [ # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # List of objects that own this object. If ALL objects in the list have
+ # been deleted, this object will be garbage collected.
+ { # 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.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then
+ # the owner cannot be deleted from the key-value store until this
+ # reference is removed.
+ # Defaults to false.
+ # 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
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code>
+ <pre>Delete a domain mapping.
+
+Args:
+ name: string, The name of the domain mapping to delete.
+For Cloud Run (fully managed), replace {namespace_id} with the project ID
+or number. (required)
+ 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Status is a return value for calls that don't return other objects
+ "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Standard list metadata.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ # +optional
+ # lists and various status objects. A resource may have only one of
+ # {ObjectMeta, ListMeta}.
+ "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.
+ # Populated by the system.
+ # Read-only.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
+ # +optional
+ "continue": "A String", # continue may be set if the user set a limit on the number of items
+ # returned, and indicates that the server has more data available. The value
+ # is opaque and may be used to issue another request to the endpoint that
+ # served this list to retrieve the next set of available objects. Continuing
+ # a list may not be possible if the server configuration has changed or more
+ # 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
+ },
+ "code": 42, # Suggested HTTP return code for this status, 0 if not set.
+ # +optional
+ "message": "A String", # A human-readable description of the status of this operation.
+ # +optional
+ "status": "A String", # Status of the operation.
+ # One of: "Success" or "Failure".
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+ # +optional
+ "details": { # StatusDetails is a set of additional properties that MAY be set by the # Extended data associated with the reason. Each reason may define its
+ # own extended details. This field is optional and the data returned
+ # is not guaranteed to conform to any schema except that defined by
+ # the reason type.
+ # +optional
+ # server to provide additional information about a response. The Reason
+ # field of a Status object defines what attributes will be set. Clients
+ # must ignore fields that do not match the defined type of each attribute,
+ # and should assume that any attribute may be empty, invalid, or under
+ # defined.
+ "name": "A String", # The name attribute of the resource associated with the status StatusReason
+ # (when there is a single name which can be described).
+ # +optional
+ "uid": "A String", # UID of the resource.
+ # (when there is a single resource which can be described).
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+ # +optional
+ "group": "A String", # The group attribute of the resource associated with the status
+ # StatusReason. +optional
+ "causes": [ # The Causes array includes more details associated with the StatusReason
+ # failure. Not all StatusReasons may provide detailed causes.
+ # +optional
+ { # StatusCause provides more information about an api.Status failure, including
+ # cases when multiple errors are encountered.
+ "message": "A String", # A human-readable description of the cause of the error. This field may be
+ # presented as-is to a reader.
+ # +optional
+ "reason": "A String", # A machine-readable description of the cause of the error. If this value is
+ # empty there is no information available.
+ # +optional
+ "field": "A String", # The field of the resource that has caused this error, as named by its JSON
+ # serialization. May include dot and postfix notation for nested attributes.
+ # Arrays are zero-indexed. Fields may appear more than once in an array of
+ # causes due to fields having multiple errors.
+ # Optional.
+ #
+ # Examples:
+ # "name" - the field "name" on the current resource
+ # "items[0].name" - the field "name" on the first array entry in "items"
+ # +optional
+ },
+ ],
+ "kind": "A String", # The kind attribute of the resource associated with the status StatusReason.
+ # On some operations may differ from the requested resource Kind.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ # +optional
+ "retryAfterSeconds": 42, # If specified, the time in seconds before the operation should be retried.
+ # Some errors may indicate the client must take an alternate action - for
+ # those errors this field may indicate how long to wait before taking the
+ # alternate action. +optional
+ },
+ "reason": "A String", # A machine-readable description of why this operation is in the
+ # "Failure" status. If this value is empty there
+ # is no information available. A Reason clarifies an HTTP status
+ # code but does not override it.
+ # +optional
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Get information about a domain mapping.
+
+Args:
+ name: string, The name of the domain mapping to retrieve.
+For Cloud Run (fully managed), replace {namespace_id} with the project ID
+or number. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ 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.
+ { # 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 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.
+ "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).
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for
+ # `CNAME` records. Example: 'www'.
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
+ "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
+ "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.
+ "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.
+ },
+ "kind": "A String", # The kind of resource, in this case "DomainMapping".
+ "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate.
+ # 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
+ # 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
+ "a_key": "A String",
+ },
+ "generateName": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # GenerateName is an optional prefix, used by the server, to generate a
+ # unique name ONLY IF the Name field has not been provided. If this field is
+ # used, the name returned to the client will be different than the name
+ # passed. This value will also be combined with a unique suffix. The provided
+ # value has the same validation rules as the Name field, and may be truncated
+ # by the length of the suffix required to make the value unique on the
+ # server.
+ #
+ # If this field is specified and the generated name exists, the server will
+ # NOT return a 409 - instead, it will either return 201 Created or 500 with
+ # Reason ServerTimeout indicating a unique name could not be found in the
+ # time allotted, and the client should retry (optionally after the time
+ # indicated in the Retry-After header).
+ #
+ # Applied only if Name is not specified.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
+ # string generateName = 2;
+ "name": "A String", # Name must be unique within a namespace, within a Cloud Run region.
+ # Is required when creating
+ # resources, although some resources may allow a client to request the
+ # generation of an appropriate name automatically. Name is primarily intended
+ # for creation idempotence and configuration definition. Cannot be updated.
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#names
+ # +optional
+ "deletionGracePeriodSeconds": 42, # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # 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.
+ "clusterName": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # 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.
+ "finalizers": [ # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # Must be empty before the object is deleted from the registry. Each entry
+ # is an identifier for the responsible component that will remove the entry
+ # from the list. If the deletionTimestamp of the object is non-nil, entries
+ # in this list can only be removed.
+ # +patchStrategy=merge
+ "A String",
+ ],
+ "deletionTimestamp": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # DeletionTimestamp is RFC 3339 date and time at which this resource will be
+ # deleted. This field is set by the server when a graceful deletion is
+ # requested by the user, and is not directly settable by a client. The
+ # resource is expected to be deleted (no longer visible from resource lists,
+ # and not reachable by name) after the time in this field, once the
+ # finalizers list is empty. As long as the finalizers list contains items,
+ # deletion is blocked. Once the deletionTimestamp is set, this value may not
+ # be unset or be set further into the future, although it may be shortened or
+ # the resource may be deleted prior to this time. For example, a user may
+ # request that a pod is deleted in 30 seconds. The Kubelet will react by
+ # sending a graceful termination signal to the containers in the pod. After
+ # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
+ # to the container and after cleanup, remove the pod from the API. In the
+ # presence of network partitions, this object may still exist after this
+ # timestamp, until an administrator or automated process can determine the
+ # resource is fully terminated.
+ # If not set, graceful deletion of the object has not been requested.
+ #
+ # Populated by the system when a graceful deletion is requested.
+ # Read-only.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+ "ownerReferences": [ # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # List of objects that own this object. If ALL objects in the list have
+ # been deleted, this object will be garbage collected.
+ { # 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.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then
+ # the owner cannot be deleted from the key-value store until this
+ # reference is removed.
+ # Defaults to false.
+ # 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
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <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>List domain mappings.
+
+Args:
+ parent: string, The namespace from which the domain mappings should be listed.
+For Cloud Run (fully managed), replace {namespace_id} with the project ID
+or number. (required)
+ labelSelector: string, Allows to filter resources based on a label. Supported operations are
+=, !=, exists, in, and notIn.
+ 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.
+Not currently used by Cloud Run.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # ListDomainMappingsResponse is a list of DomainMapping resources.
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
+ "kind": "A String", # The kind of this resource, in this case "DomainMappingList".
+ "unreachable": [ # Locations that could not be reached.
+ "A String",
+ ],
+ "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this DomainMapping list.
+ # lists and various status objects. A resource may have only one of
+ # {ObjectMeta, ListMeta}.
+ "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.
+ # Populated by the system.
+ # Read-only.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
+ # +optional
+ "continue": "A String", # continue may be set if the user set a limit on the number of items
+ # returned, and indicates that the server has more data available. The value
+ # is opaque and may be used to issue another request to the endpoint that
+ # served this list to retrieve the next set of available objects. Continuing
+ # a list may not be possible if the server configuration has changed or more
+ # 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 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.
+ { # 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 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.
+ "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).
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for
+ # `CNAME` records. Example: 'www'.
+ },
+ ],
+ },
+ "apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
+ "spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
+ "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.
+ "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.
+ },
+ "kind": "A String", # The kind of resource, in this case "DomainMapping".
+ "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate.
+ # 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
+ # 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
+ "a_key": "A String",
+ },
+ "generateName": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # GenerateName is an optional prefix, used by the server, to generate a
+ # unique name ONLY IF the Name field has not been provided. If this field is
+ # used, the name returned to the client will be different than the name
+ # passed. This value will also be combined with a unique suffix. The provided
+ # value has the same validation rules as the Name field, and may be truncated
+ # by the length of the suffix required to make the value unique on the
+ # server.
+ #
+ # If this field is specified and the generated name exists, the server will
+ # NOT return a 409 - instead, it will either return 201 Created or 500 with
+ # Reason ServerTimeout indicating a unique name could not be found in the
+ # time allotted, and the client should retry (optionally after the time
+ # indicated in the Retry-After header).
+ #
+ # Applied only if Name is not specified.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
+ # string generateName = 2;
+ "name": "A String", # Name must be unique within a namespace, within a Cloud Run region.
+ # Is required when creating
+ # resources, although some resources may allow a client to request the
+ # generation of an appropriate name automatically. Name is primarily intended
+ # for creation idempotence and configuration definition. Cannot be updated.
+ # More info: http://kubernetes.io/docs/user-guide/identifiers#names
+ # +optional
+ "deletionGracePeriodSeconds": 42, # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # 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.
+ "clusterName": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # 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.
+ "finalizers": [ # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # Must be empty before the object is deleted from the registry. Each entry
+ # is an identifier for the responsible component that will remove the entry
+ # from the list. If the deletionTimestamp of the object is non-nil, entries
+ # in this list can only be removed.
+ # +patchStrategy=merge
+ "A String",
+ ],
+ "deletionTimestamp": "A String", # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # DeletionTimestamp is RFC 3339 date and time at which this resource will be
+ # deleted. This field is set by the server when a graceful deletion is
+ # requested by the user, and is not directly settable by a client. The
+ # resource is expected to be deleted (no longer visible from resource lists,
+ # and not reachable by name) after the time in this field, once the
+ # finalizers list is empty. As long as the finalizers list contains items,
+ # deletion is blocked. Once the deletionTimestamp is set, this value may not
+ # be unset or be set further into the future, although it may be shortened or
+ # the resource may be deleted prior to this time. For example, a user may
+ # request that a pod is deleted in 30 seconds. The Kubelet will react by
+ # sending a graceful termination signal to the containers in the pod. After
+ # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)
+ # to the container and after cleanup, remove the pod from the API. In the
+ # presence of network partitions, this object may still exist after this
+ # timestamp, until an administrator or automated process can determine the
+ # resource is fully terminated.
+ # If not set, graceful deletion of the object has not been requested.
+ #
+ # Populated by the system when a graceful deletion is requested.
+ # Read-only.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+ "ownerReferences": [ # (Optional)
+ #
+ # Cloud Run fully managed: not supported
+ #
+ # Cloud Run for Anthos: supported
+ #
+ # List of objects that own this object. If ALL objects in the list have
+ # been deleted, this object will be garbage collected.
+ { # 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.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then
+ # the owner cannot be deleted from the key-value store until this
+ # reference is removed.
+ # Defaults to false.
+ # 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
+ },
+ ],
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file