docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/run_v1alpha1.projects.locations.cloudpubsubsources.html b/docs/dyn/run_v1alpha1.projects.locations.cloudpubsubsources.html
index 62da624..b47cfea 100644
--- a/docs/dyn/run_v1alpha1.projects.locations.cloudpubsubsources.html
+++ b/docs/dyn/run_v1alpha1.projects.locations.cloudpubsubsources.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Rpc to get information about a cloudpubsubsource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, x__xgafv=None)</a></code></p>
+ <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>
<p class="firstline">Rpc to list cloudpubsubsources.</p>
<h3>Method Details</h3>
<div class="method">
@@ -103,6 +103,9 @@
"conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state
# of the CloudPubSubSource.
{ # 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.
@@ -110,9 +113,6 @@
# 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.
- "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.
},
],
"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that
@@ -123,19 +123,91 @@
},
"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".
"spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.
+ "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create
+ # Topic / PullSubscription resources. If omitted, uses Secret.
+ #
+ # Cloud Run on GKE: supported
+ #
+ # SecretKeySelector selects a key of a Secret.
+ "optional": True or False, # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # Specify whether the Secret or its key must be defined
+ # +optional
+ "key": "A String", # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # The key of the secret to select from. Must be a valid secret key.
+ "name": "A String", # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # The name of the secret in the pod's namespace to select from.
+ "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
+ # directly into the message. Use the "name" field instead.
+ # referenced object inside the same namespace.
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ },
+ },
+ "sink": { # Sink is a reference to an object that will resolve to a domain name or a
+ # URI directly to use as the sink.
+ "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from
+ # Addressable ObjectReference. If used with an ObjectReference, will be
+ # appended to the path of the resulting URL from the Addressable.
+ # + optional
+ "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.
+ # + optional
+ # referred object.
+ "apiVersion": "A String", # API version of the referent.
+ # +optional
+ "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
+ # +optional
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ # +optional
+ "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this
+ # string should contain a valid JSON/Go field access statement, such as
+ # desiredState.manifest.containers[2]. For example, if the object reference
+ # is to a container within a pod, this would take on a value like:
+ # "spec.containers{name}" (where "name" refers to the name of the container
+ # that triggered the event) or if no container name is specified
+ # "spec.containers[2]" (container with index 2 in this pod). This syntax is
+ # chosen only to have some well-defined way of referencing a part of an
+ # object.
+ "uid": "A String", # UID of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ # +optional
+ "namespace": "A String", # Namespace of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ # +optional
+ "kind": "A String", # Kind of the referent.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ # +optional
+ },
+ },
"retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If
# true, acknowledged messages will not be expunged until they fall out of
# the RetentionDuration window.
+ "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a
+ # message before the subscriber should acknowledge the message. Defaults
+ # to 30 seconds ('30s').
+ # +optional
"retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from
# the time of publish. If RetainAckedMessages is true, this duration
# affects the retention of acknowledged messages, otherwise only
# unacknowledged messages are retained. Cannot be longer than 7 days or
# shorter than 10 minutes. Defaults to 7 days ('7d').
# +optional
- "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a
- # message before the subscriber should acknowledge the message. Defaults
- # to 30 seconds ('30s').
- # +optional
"ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and
# modifications of the event sent to the sink.
# +optional
@@ -156,13 +228,6 @@
# Cloud Run on GKE: supported
#
# SecretKeySelector selects a key of a Secret.
- "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
- # directly into the message. Use the "name" field instead.
- # referenced object inside the same namespace.
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- },
"optional": True or False, # Cloud Run fully managed: not supported
#
# Cloud Run on GKE: supported
@@ -179,95 +244,24 @@
# Cloud Run on GKE: supported
#
# The name of the secret in the pod's namespace to select from.
+ "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
+ # directly into the message. Use the "name" field instead.
+ # referenced object inside the same namespace.
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ },
},
- "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource
- # Topic exists in. If omitted, defaults to same as the cluster. +optional
"topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must
# be in the form of the unique identifier within the project, not the
# entire name. E.g. it must be 'laconia', not
# 'projects/my-proj/topics/laconia'.
- "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create
- # Topic / PullSubscription resources. If omitted, uses Secret.
- #
- # Cloud Run on GKE: supported
- #
- # SecretKeySelector selects a key of a Secret.
- "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
- # directly into the message. Use the "name" field instead.
- # referenced object inside the same namespace.
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- },
- "optional": True or False, # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # Specify whether the Secret or its key must be defined
- # +optional
- "key": "A String", # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # The key of the secret to select from. Must be a valid secret key.
- "name": "A String", # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # The name of the secret in the pod's namespace to select from.
- },
- "sink": { # Sink is a reference to an object that will resolve to a domain name or a
- # URI directly to use as the sink.
- "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from
- # Addressable ObjectReference. If used with an ObjectReference, will be
- # appended to the path of the resulting URL from the Addressable.
- # + optional
- "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.
- # + optional
- # referred object.
- "apiVersion": "A String", # API version of the referent.
- # +optional
- "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- # +optional
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- # +optional
- "uid": "A String", # UID of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- # +optional
- "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this
- # string should contain a valid JSON/Go field access statement, such as
- # desiredState.manifest.containers[2]. For example, if the object reference
- # is to a container within a pod, this would take on a value like:
- # "spec.containers{name}" (where "name" refers to the name of the container
- # that triggered the event) or if no container name is specified
- # "spec.containers[2]" (container with index 2 in this pod). This syntax is
- # chosen only to have some well-defined way of referencing a part of an
- # object.
- "namespace": "A String", # Namespace of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
- # +optional
- "kind": "A String", # Kind of the referent.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
- # +optional
- },
- },
+ "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource
+ # Topic exists in. If omitted, defaults to same as the cluster. +optional
},
"kind": "A String", # The kind of resource, in this case "CloudPubSubSource".
"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudPubSubSource.
# 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
@@ -296,17 +290,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
@@ -346,11 +340,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.
@@ -363,6 +352,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
@@ -399,6 +393,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.
@@ -407,14 +406,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.
+ "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",
+ },
},
}
@@ -432,6 +432,9 @@
"conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state
# of the CloudPubSubSource.
{ # 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.
@@ -439,9 +442,6 @@
# 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.
- "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.
},
],
"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that
@@ -452,19 +452,91 @@
},
"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".
"spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.
+ "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create
+ # Topic / PullSubscription resources. If omitted, uses Secret.
+ #
+ # Cloud Run on GKE: supported
+ #
+ # SecretKeySelector selects a key of a Secret.
+ "optional": True or False, # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # Specify whether the Secret or its key must be defined
+ # +optional
+ "key": "A String", # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # The key of the secret to select from. Must be a valid secret key.
+ "name": "A String", # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # The name of the secret in the pod's namespace to select from.
+ "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
+ # directly into the message. Use the "name" field instead.
+ # referenced object inside the same namespace.
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ },
+ },
+ "sink": { # Sink is a reference to an object that will resolve to a domain name or a
+ # URI directly to use as the sink.
+ "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from
+ # Addressable ObjectReference. If used with an ObjectReference, will be
+ # appended to the path of the resulting URL from the Addressable.
+ # + optional
+ "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.
+ # + optional
+ # referred object.
+ "apiVersion": "A String", # API version of the referent.
+ # +optional
+ "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
+ # +optional
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ # +optional
+ "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this
+ # string should contain a valid JSON/Go field access statement, such as
+ # desiredState.manifest.containers[2]. For example, if the object reference
+ # is to a container within a pod, this would take on a value like:
+ # "spec.containers{name}" (where "name" refers to the name of the container
+ # that triggered the event) or if no container name is specified
+ # "spec.containers[2]" (container with index 2 in this pod). This syntax is
+ # chosen only to have some well-defined way of referencing a part of an
+ # object.
+ "uid": "A String", # UID of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ # +optional
+ "namespace": "A String", # Namespace of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ # +optional
+ "kind": "A String", # Kind of the referent.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ # +optional
+ },
+ },
"retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If
# true, acknowledged messages will not be expunged until they fall out of
# the RetentionDuration window.
+ "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a
+ # message before the subscriber should acknowledge the message. Defaults
+ # to 30 seconds ('30s').
+ # +optional
"retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from
# the time of publish. If RetainAckedMessages is true, this duration
# affects the retention of acknowledged messages, otherwise only
# unacknowledged messages are retained. Cannot be longer than 7 days or
# shorter than 10 minutes. Defaults to 7 days ('7d').
# +optional
- "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a
- # message before the subscriber should acknowledge the message. Defaults
- # to 30 seconds ('30s').
- # +optional
"ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and
# modifications of the event sent to the sink.
# +optional
@@ -485,13 +557,6 @@
# Cloud Run on GKE: supported
#
# SecretKeySelector selects a key of a Secret.
- "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
- # directly into the message. Use the "name" field instead.
- # referenced object inside the same namespace.
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- },
"optional": True or False, # Cloud Run fully managed: not supported
#
# Cloud Run on GKE: supported
@@ -508,95 +573,24 @@
# Cloud Run on GKE: supported
#
# The name of the secret in the pod's namespace to select from.
+ "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
+ # directly into the message. Use the "name" field instead.
+ # referenced object inside the same namespace.
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ },
},
- "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource
- # Topic exists in. If omitted, defaults to same as the cluster. +optional
"topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must
# be in the form of the unique identifier within the project, not the
# entire name. E.g. it must be 'laconia', not
# 'projects/my-proj/topics/laconia'.
- "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create
- # Topic / PullSubscription resources. If omitted, uses Secret.
- #
- # Cloud Run on GKE: supported
- #
- # SecretKeySelector selects a key of a Secret.
- "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
- # directly into the message. Use the "name" field instead.
- # referenced object inside the same namespace.
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- },
- "optional": True or False, # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # Specify whether the Secret or its key must be defined
- # +optional
- "key": "A String", # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # The key of the secret to select from. Must be a valid secret key.
- "name": "A String", # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # The name of the secret in the pod's namespace to select from.
- },
- "sink": { # Sink is a reference to an object that will resolve to a domain name or a
- # URI directly to use as the sink.
- "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from
- # Addressable ObjectReference. If used with an ObjectReference, will be
- # appended to the path of the resulting URL from the Addressable.
- # + optional
- "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.
- # + optional
- # referred object.
- "apiVersion": "A String", # API version of the referent.
- # +optional
- "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- # +optional
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- # +optional
- "uid": "A String", # UID of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- # +optional
- "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this
- # string should contain a valid JSON/Go field access statement, such as
- # desiredState.manifest.containers[2]. For example, if the object reference
- # is to a container within a pod, this would take on a value like:
- # "spec.containers{name}" (where "name" refers to the name of the container
- # that triggered the event) or if no container name is specified
- # "spec.containers[2]" (container with index 2 in this pod). This syntax is
- # chosen only to have some well-defined way of referencing a part of an
- # object.
- "namespace": "A String", # Namespace of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
- # +optional
- "kind": "A String", # Kind of the referent.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
- # +optional
- },
- },
+ "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource
+ # Topic exists in. If omitted, defaults to same as the cluster. +optional
},
"kind": "A String", # The kind of resource, in this case "CloudPubSubSource".
"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudPubSubSource.
# 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
@@ -625,17 +619,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
@@ -675,11 +669,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.
@@ -692,6 +681,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
@@ -728,6 +722,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.
@@ -736,14 +735,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.
+ "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>
@@ -802,6 +802,9 @@
"conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state
# of the CloudPubSubSource.
{ # 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.
@@ -809,9 +812,6 @@
# 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.
- "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.
},
],
"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that
@@ -822,19 +822,91 @@
},
"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".
"spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.
+ "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create
+ # Topic / PullSubscription resources. If omitted, uses Secret.
+ #
+ # Cloud Run on GKE: supported
+ #
+ # SecretKeySelector selects a key of a Secret.
+ "optional": True or False, # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # Specify whether the Secret or its key must be defined
+ # +optional
+ "key": "A String", # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # The key of the secret to select from. Must be a valid secret key.
+ "name": "A String", # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # The name of the secret in the pod's namespace to select from.
+ "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
+ # directly into the message. Use the "name" field instead.
+ # referenced object inside the same namespace.
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ },
+ },
+ "sink": { # Sink is a reference to an object that will resolve to a domain name or a
+ # URI directly to use as the sink.
+ "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from
+ # Addressable ObjectReference. If used with an ObjectReference, will be
+ # appended to the path of the resulting URL from the Addressable.
+ # + optional
+ "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.
+ # + optional
+ # referred object.
+ "apiVersion": "A String", # API version of the referent.
+ # +optional
+ "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
+ # +optional
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ # +optional
+ "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this
+ # string should contain a valid JSON/Go field access statement, such as
+ # desiredState.manifest.containers[2]. For example, if the object reference
+ # is to a container within a pod, this would take on a value like:
+ # "spec.containers{name}" (where "name" refers to the name of the container
+ # that triggered the event) or if no container name is specified
+ # "spec.containers[2]" (container with index 2 in this pod). This syntax is
+ # chosen only to have some well-defined way of referencing a part of an
+ # object.
+ "uid": "A String", # UID of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ # +optional
+ "namespace": "A String", # Namespace of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ # +optional
+ "kind": "A String", # Kind of the referent.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ # +optional
+ },
+ },
"retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If
# true, acknowledged messages will not be expunged until they fall out of
# the RetentionDuration window.
+ "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a
+ # message before the subscriber should acknowledge the message. Defaults
+ # to 30 seconds ('30s').
+ # +optional
"retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from
# the time of publish. If RetainAckedMessages is true, this duration
# affects the retention of acknowledged messages, otherwise only
# unacknowledged messages are retained. Cannot be longer than 7 days or
# shorter than 10 minutes. Defaults to 7 days ('7d').
# +optional
- "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a
- # message before the subscriber should acknowledge the message. Defaults
- # to 30 seconds ('30s').
- # +optional
"ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and
# modifications of the event sent to the sink.
# +optional
@@ -855,13 +927,6 @@
# Cloud Run on GKE: supported
#
# SecretKeySelector selects a key of a Secret.
- "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
- # directly into the message. Use the "name" field instead.
- # referenced object inside the same namespace.
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- },
"optional": True or False, # Cloud Run fully managed: not supported
#
# Cloud Run on GKE: supported
@@ -878,95 +943,24 @@
# Cloud Run on GKE: supported
#
# The name of the secret in the pod's namespace to select from.
+ "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
+ # directly into the message. Use the "name" field instead.
+ # referenced object inside the same namespace.
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ },
},
- "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource
- # Topic exists in. If omitted, defaults to same as the cluster. +optional
"topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must
# be in the form of the unique identifier within the project, not the
# entire name. E.g. it must be 'laconia', not
# 'projects/my-proj/topics/laconia'.
- "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create
- # Topic / PullSubscription resources. If omitted, uses Secret.
- #
- # Cloud Run on GKE: supported
- #
- # SecretKeySelector selects a key of a Secret.
- "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
- # directly into the message. Use the "name" field instead.
- # referenced object inside the same namespace.
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- },
- "optional": True or False, # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # Specify whether the Secret or its key must be defined
- # +optional
- "key": "A String", # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # The key of the secret to select from. Must be a valid secret key.
- "name": "A String", # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # The name of the secret in the pod's namespace to select from.
- },
- "sink": { # Sink is a reference to an object that will resolve to a domain name or a
- # URI directly to use as the sink.
- "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from
- # Addressable ObjectReference. If used with an ObjectReference, will be
- # appended to the path of the resulting URL from the Addressable.
- # + optional
- "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.
- # + optional
- # referred object.
- "apiVersion": "A String", # API version of the referent.
- # +optional
- "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- # +optional
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- # +optional
- "uid": "A String", # UID of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- # +optional
- "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this
- # string should contain a valid JSON/Go field access statement, such as
- # desiredState.manifest.containers[2]. For example, if the object reference
- # is to a container within a pod, this would take on a value like:
- # "spec.containers{name}" (where "name" refers to the name of the container
- # that triggered the event) or if no container name is specified
- # "spec.containers[2]" (container with index 2 in this pod). This syntax is
- # chosen only to have some well-defined way of referencing a part of an
- # object.
- "namespace": "A String", # Namespace of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
- # +optional
- "kind": "A String", # Kind of the referent.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
- # +optional
- },
- },
+ "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource
+ # Topic exists in. If omitted, defaults to same as the cluster. +optional
},
"kind": "A String", # The kind of resource, in this case "CloudPubSubSource".
"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudPubSubSource.
# 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
@@ -995,17 +989,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
@@ -1045,11 +1039,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.
@@ -1062,6 +1051,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
@@ -1098,6 +1092,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.
@@ -1106,29 +1105,26 @@
# 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.
+ "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, continue=None, limit=None, watch=None, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, x__xgafv=None)</code>
+ <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>
<pre>Rpc to list cloudpubsubsources.
Args:
parent: string, The project ID or project number from which the cloudpubsubsources should
be listed. (required)
- continue: string, Optional encoded string to continue paging.
- limit: integer, The maximum number of records that should be returned.
- watch: boolean, Flag that indicates that the client expects to watch this resource as well.
-Not currently used by Cloud Run.
labelSelector: string, Allows to filter resources based on a label. Supported operations are
=, !=, exists, in, and notIn.
resourceVersion: string, The baseline resource version from which the list or watch operation should
@@ -1137,6 +1133,10 @@
fieldSelector: string, Allows to filter resources based on a specific value for a field name.
Send this in a query string format. i.e. 'metadata.name%3Dlorem'.
Not currently used by Cloud Run.
+ continue: string, Optional encoded string to continue paging.
+ limit: integer, The maximum number of records that should be returned.
+ watch: boolean, Flag that indicates that the client expects to watch this resource as well.
+Not currently used by Cloud Run.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1146,7 +1146,6 @@
An object of the form:
{ # ListCloudPubSubSourcesResponse is a list of CloudPubSubSource resources.
- "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".
"kind": "A String", # The kind of this resource, in this case "CloudPubSubSourceList".
"unreachable": [ # Locations that could not be reached.
"A String",
@@ -1182,6 +1181,9 @@
"conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state
# of the CloudPubSubSource.
{ # 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.
@@ -1189,9 +1191,6 @@
# 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.
- "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.
},
],
"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that
@@ -1202,19 +1201,91 @@
},
"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".
"spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.
+ "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create
+ # Topic / PullSubscription resources. If omitted, uses Secret.
+ #
+ # Cloud Run on GKE: supported
+ #
+ # SecretKeySelector selects a key of a Secret.
+ "optional": True or False, # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # Specify whether the Secret or its key must be defined
+ # +optional
+ "key": "A String", # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # The key of the secret to select from. Must be a valid secret key.
+ "name": "A String", # Cloud Run fully managed: not supported
+ #
+ # Cloud Run on GKE: supported
+ #
+ # The name of the secret in the pod's namespace to select from.
+ "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
+ # directly into the message. Use the "name" field instead.
+ # referenced object inside the same namespace.
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ },
+ },
+ "sink": { # Sink is a reference to an object that will resolve to a domain name or a
+ # URI directly to use as the sink.
+ "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from
+ # Addressable ObjectReference. If used with an ObjectReference, will be
+ # appended to the path of the resulting URL from the Addressable.
+ # + optional
+ "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.
+ # + optional
+ # referred object.
+ "apiVersion": "A String", # API version of the referent.
+ # +optional
+ "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
+ # +optional
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ # +optional
+ "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this
+ # string should contain a valid JSON/Go field access statement, such as
+ # desiredState.manifest.containers[2]. For example, if the object reference
+ # is to a container within a pod, this would take on a value like:
+ # "spec.containers{name}" (where "name" refers to the name of the container
+ # that triggered the event) or if no container name is specified
+ # "spec.containers[2]" (container with index 2 in this pod). This syntax is
+ # chosen only to have some well-defined way of referencing a part of an
+ # object.
+ "uid": "A String", # UID of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ # +optional
+ "namespace": "A String", # Namespace of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ # +optional
+ "kind": "A String", # Kind of the referent.
+ # More info:
+ # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+ # +optional
+ },
+ },
"retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If
# true, acknowledged messages will not be expunged until they fall out of
# the RetentionDuration window.
+ "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a
+ # message before the subscriber should acknowledge the message. Defaults
+ # to 30 seconds ('30s').
+ # +optional
"retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from
# the time of publish. If RetainAckedMessages is true, this duration
# affects the retention of acknowledged messages, otherwise only
# unacknowledged messages are retained. Cannot be longer than 7 days or
# shorter than 10 minutes. Defaults to 7 days ('7d').
# +optional
- "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a
- # message before the subscriber should acknowledge the message. Defaults
- # to 30 seconds ('30s').
- # +optional
"ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and
# modifications of the event sent to the sink.
# +optional
@@ -1235,13 +1306,6 @@
# Cloud Run on GKE: supported
#
# SecretKeySelector selects a key of a Secret.
- "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
- # directly into the message. Use the "name" field instead.
- # referenced object inside the same namespace.
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- },
"optional": True or False, # Cloud Run fully managed: not supported
#
# Cloud Run on GKE: supported
@@ -1258,95 +1322,24 @@
# Cloud Run on GKE: supported
#
# The name of the secret in the pod's namespace to select from.
+ "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
+ # directly into the message. Use the "name" field instead.
+ # referenced object inside the same namespace.
+ "name": "A String", # Name of the referent.
+ # More info:
+ # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ },
},
- "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource
- # Topic exists in. If omitted, defaults to same as the cluster. +optional
"topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must
# be in the form of the unique identifier within the project, not the
# entire name. E.g. it must be 'laconia', not
# 'projects/my-proj/topics/laconia'.
- "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create
- # Topic / PullSubscription resources. If omitted, uses Secret.
- #
- # Cloud Run on GKE: supported
- #
- # SecretKeySelector selects a key of a Secret.
- "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined
- # directly into the message. Use the "name" field instead.
- # referenced object inside the same namespace.
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- },
- "optional": True or False, # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # Specify whether the Secret or its key must be defined
- # +optional
- "key": "A String", # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # The key of the secret to select from. Must be a valid secret key.
- "name": "A String", # Cloud Run fully managed: not supported
- #
- # Cloud Run on GKE: supported
- #
- # The name of the secret in the pod's namespace to select from.
- },
- "sink": { # Sink is a reference to an object that will resolve to a domain name or a
- # URI directly to use as the sink.
- "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from
- # Addressable ObjectReference. If used with an ObjectReference, will be
- # appended to the path of the resulting URL from the Addressable.
- # + optional
- "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.
- # + optional
- # referred object.
- "apiVersion": "A String", # API version of the referent.
- # +optional
- "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- # +optional
- "name": "A String", # Name of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- # +optional
- "uid": "A String", # UID of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- # +optional
- "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this
- # string should contain a valid JSON/Go field access statement, such as
- # desiredState.manifest.containers[2]. For example, if the object reference
- # is to a container within a pod, this would take on a value like:
- # "spec.containers{name}" (where "name" refers to the name of the container
- # that triggered the event) or if no container name is specified
- # "spec.containers[2]" (container with index 2 in this pod). This syntax is
- # chosen only to have some well-defined way of referencing a part of an
- # object.
- "namespace": "A String", # Namespace of the referent.
- # More info:
- # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
- # +optional
- "kind": "A String", # Kind of the referent.
- # More info:
- # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
- # +optional
- },
- },
+ "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource
+ # Topic exists in. If omitted, defaults to same as the cluster. +optional
},
"kind": "A String", # The kind of resource, in this case "CloudPubSubSource".
"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudPubSubSource.
# 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
@@ -1375,17 +1368,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
@@ -1425,11 +1418,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.
@@ -1442,6 +1430,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
@@ -1478,6 +1471,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.
@@ -1486,17 +1484,19 @@
# 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.
+ "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",
+ },
},
},
],
+ "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".
}</pre>
</div>