blob: 332f4342cb3c862ea7aadd896a57e2c99b3adbc9 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="run_v1alpha1.html">Cloud Run Admin API</a> . <a href="run_v1alpha1.namespaces.html">namespaces</a> . <a href="run_v1alpha1.namespaces.cloudpubsubsources.html">cloudpubsubsources</a></h1>
Bu Sun Kim65020912020-05-20 12:08:20 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a new cloudpubsubsource.</p>
83<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080084 <code><a href="#delete">delete(name, propagationPolicy=None, apiVersion=None, kind=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070085<p class="firstline">Rpc to delete a cloudpubsubsource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Rpc to get information about a cloudpubsubsource.</p>
89<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080090 <code><a href="#list">list(parent, resourceVersion=None, limit=None, continue=None, fieldSelector=None, watch=None, includeUninitialized=None, labelSelector=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070091<p class="firstline">Rpc to list cloudpubsubsources.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -070099 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
100 <pre>Creates a new cloudpubsubsource.
101
102Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700103 parent: string, The project ID or project number in which this cloudpubsubsource should be created. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 body: object, The request body.
105 The object takes the form of:
106
107{
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800108 &quot;spec&quot;: { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.
109 &quot;ackDeadline&quot;: &quot;A String&quot;, # AckDeadline is the default maximum time after a subscriber receives a message before the subscriber should acknowledge the message. Defaults to 30 seconds (&#x27;30s&#x27;). +optional
110 &quot;pubsubSecret&quot;: { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # CloudPubSubSourceSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret.
111 &quot;key&quot;: &quot;A String&quot;, # 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.
112 &quot;optional&quot;: 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
113 &quot;name&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod&#x27;s namespace to select from.
114 &quot;localObjectReference&quot;: { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the &quot;name&quot; field instead.
115 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
116 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800117 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800118 &quot;secret&quot;: { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional
119 &quot;key&quot;: &quot;A String&quot;, # 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.
120 &quot;optional&quot;: 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
121 &quot;name&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod&#x27;s namespace to select from.
122 &quot;localObjectReference&quot;: { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the &quot;name&quot; field instead.
123 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
124 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800125 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800126 &quot;project&quot;: &quot;A String&quot;, # Project is the ID of the Google Cloud Project that the CloudPubSubSource Topic exists in. If omitted, defaults to same as the cluster. +optional
127 &quot;retainAckedMessages&quot;: 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.
128 &quot;topic&quot;: &quot;A String&quot;, # 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 &#x27;laconia&#x27;, not &#x27;projects/my-proj/topics/laconia&#x27;.
129 &quot;retentionDuration&quot;: &quot;A String&quot;, # 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 (&#x27;7d&#x27;). +optional
130 &quot;sink&quot;: { # Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink.
131 &quot;uri&quot;: &quot;A String&quot;, # 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
132 &quot;ref&quot;: { # ObjectReference contains enough information to let you inspect or modify the referred object. # ObjectReference points to an Addressable. + optional
133 &quot;namespace&quot;: &quot;A String&quot;, # Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional
134 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
135 &quot;fieldPath&quot;: &quot;A String&quot;, # 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: &quot;spec.containers{name}&quot; (where &quot;name&quot; refers to the name of the container that triggered the event) or if no container name is specified &quot;spec.containers[2]&quot; (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.
136 &quot;resourceVersion&quot;: &quot;A String&quot;, # 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
137 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional
138 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional
139 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent. +optional
140 },
141 },
142 &quot;ceOverrides&quot;: { # CloudEventOverrides defines arguments for a Source that control the output format of the CloudEvents produced by the Source. # CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional
143 &quot;extensions&quot;: { # Extensions specify what attribute are added or overridden on the outbound event. Each `Extensions` key-value pair are set on the event as an attribute extension independently. +optional
144 &quot;a_key&quot;: &quot;A String&quot;,
145 },
146 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800147 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800148 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;events.cloud.google.com/v1alpha1&quot;.
149 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CloudPubSubSource.
150 &quot;uid&quot;: &quot;A String&quot;, # 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 +optional
151 &quot;creationTimestamp&quot;: &quot;A String&quot;, # 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 +optional
152 &quot;namespace&quot;: &quot;A String&quot;, # 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.
153 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
154 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
155 &quot;labels&quot;: { # 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 +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700156 &quot;a_key&quot;: &quot;A String&quot;,
157 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800158 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional
159 { # 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.
160 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; 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 &quot;delete&quot; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
161 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
162 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
163 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
164 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
165 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
166 },
167 ],
168 &quot;name&quot;: &quot;A String&quot;, # 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
169 &quot;clusterName&quot;: &quot;A String&quot;, # 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
170 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. 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 +optional string generateName = 2;
171 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # 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 +optional
172 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run. 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. +optional +patchStrategy=merge
173 &quot;A String&quot;,
174 ],
175 &quot;deletionGracePeriodSeconds&quot;: 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
176 &quot;annotations&quot;: { # 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
177 &quot;a_key&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700178 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800179 &quot;resourceVersion&quot;: &quot;A String&quot;, # 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 +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700180 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800181 &quot;status&quot;: { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional
182 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the CloudPubSubSource that was last processed by the controller.
183 &quot;conditions&quot;: [ # Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource.
184 { # Condition defines a generic condition for a Resource
185 &quot;reason&quot;: &quot;A String&quot;, # Optional. One-word CamelCase reason for the condition&#x27;s last transition.
186 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Optional. Last time the condition transitioned from one status to another.
187 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
188 &quot;severity&quot;: &quot;A String&quot;, # Optional. How to interpret failures of this condition, one of Error, Warning, Info
189 &quot;type&quot;: &quot;A String&quot;, # 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: * &quot;Ready&quot;: True when the Resource is ready.
190 &quot;message&quot;: &quot;A String&quot;, # Optional. Human readable message indicating details about the current status.
191 },
192 ],
193 &quot;sinkUri&quot;: &quot;A String&quot;, # SinkURI is the current active sink URI that has been configured for the Source. +optional
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800194 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800195 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;CloudPubSubSource&quot;.
196 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700197
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203Returns:
204 An object of the form:
205
206 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800207 &quot;spec&quot;: { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.
208 &quot;ackDeadline&quot;: &quot;A String&quot;, # AckDeadline is the default maximum time after a subscriber receives a message before the subscriber should acknowledge the message. Defaults to 30 seconds (&#x27;30s&#x27;). +optional
209 &quot;pubsubSecret&quot;: { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # CloudPubSubSourceSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret.
210 &quot;key&quot;: &quot;A String&quot;, # 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.
211 &quot;optional&quot;: 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
212 &quot;name&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod&#x27;s namespace to select from.
213 &quot;localObjectReference&quot;: { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the &quot;name&quot; field instead.
214 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
215 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800216 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800217 &quot;secret&quot;: { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional
218 &quot;key&quot;: &quot;A String&quot;, # 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.
219 &quot;optional&quot;: 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
220 &quot;name&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod&#x27;s namespace to select from.
221 &quot;localObjectReference&quot;: { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the &quot;name&quot; field instead.
222 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
223 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800224 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800225 &quot;project&quot;: &quot;A String&quot;, # Project is the ID of the Google Cloud Project that the CloudPubSubSource Topic exists in. If omitted, defaults to same as the cluster. +optional
226 &quot;retainAckedMessages&quot;: 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.
227 &quot;topic&quot;: &quot;A String&quot;, # 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 &#x27;laconia&#x27;, not &#x27;projects/my-proj/topics/laconia&#x27;.
228 &quot;retentionDuration&quot;: &quot;A String&quot;, # 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 (&#x27;7d&#x27;). +optional
229 &quot;sink&quot;: { # Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink.
230 &quot;uri&quot;: &quot;A String&quot;, # 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
231 &quot;ref&quot;: { # ObjectReference contains enough information to let you inspect or modify the referred object. # ObjectReference points to an Addressable. + optional
232 &quot;namespace&quot;: &quot;A String&quot;, # Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional
233 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
234 &quot;fieldPath&quot;: &quot;A String&quot;, # 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: &quot;spec.containers{name}&quot; (where &quot;name&quot; refers to the name of the container that triggered the event) or if no container name is specified &quot;spec.containers[2]&quot; (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.
235 &quot;resourceVersion&quot;: &quot;A String&quot;, # 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
236 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional
237 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional
238 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent. +optional
239 },
240 },
241 &quot;ceOverrides&quot;: { # CloudEventOverrides defines arguments for a Source that control the output format of the CloudEvents produced by the Source. # CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional
242 &quot;extensions&quot;: { # Extensions specify what attribute are added or overridden on the outbound event. Each `Extensions` key-value pair are set on the event as an attribute extension independently. +optional
243 &quot;a_key&quot;: &quot;A String&quot;,
244 },
245 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800246 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800247 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;events.cloud.google.com/v1alpha1&quot;.
248 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CloudPubSubSource.
249 &quot;uid&quot;: &quot;A String&quot;, # 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 +optional
250 &quot;creationTimestamp&quot;: &quot;A String&quot;, # 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 +optional
251 &quot;namespace&quot;: &quot;A String&quot;, # 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.
252 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
253 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
254 &quot;labels&quot;: { # 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 +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700255 &quot;a_key&quot;: &quot;A String&quot;,
256 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800257 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional
258 { # 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.
259 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; 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 &quot;delete&quot; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
260 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
261 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
262 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
263 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
264 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
265 },
266 ],
267 &quot;name&quot;: &quot;A String&quot;, # 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
268 &quot;clusterName&quot;: &quot;A String&quot;, # 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
269 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. 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 +optional string generateName = 2;
270 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # 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 +optional
271 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run. 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. +optional +patchStrategy=merge
272 &quot;A String&quot;,
273 ],
274 &quot;deletionGracePeriodSeconds&quot;: 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
275 &quot;annotations&quot;: { # 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
276 &quot;a_key&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700277 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800278 &quot;resourceVersion&quot;: &quot;A String&quot;, # 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 +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700279 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800280 &quot;status&quot;: { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional
281 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the CloudPubSubSource that was last processed by the controller.
282 &quot;conditions&quot;: [ # Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource.
283 { # Condition defines a generic condition for a Resource
284 &quot;reason&quot;: &quot;A String&quot;, # Optional. One-word CamelCase reason for the condition&#x27;s last transition.
285 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Optional. Last time the condition transitioned from one status to another.
286 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
287 &quot;severity&quot;: &quot;A String&quot;, # Optional. How to interpret failures of this condition, one of Error, Warning, Info
288 &quot;type&quot;: &quot;A String&quot;, # 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: * &quot;Ready&quot;: True when the Resource is ready.
289 &quot;message&quot;: &quot;A String&quot;, # Optional. Human readable message indicating details about the current status.
290 },
291 ],
292 &quot;sinkUri&quot;: &quot;A String&quot;, # SinkURI is the current active sink URI that has been configured for the Source. +optional
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800293 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800294 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;CloudPubSubSource&quot;.
295 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700296</div>
297
298<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800299 <code class="details" id="delete">delete(name, propagationPolicy=None, apiVersion=None, kind=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700300 <pre>Rpc to delete a cloudpubsubsource.
301
302Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700303 name: string, The name of the cloudpubsubsource being deleted. If needed, replace {namespace_id} with the project ID. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700304 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800305 apiVersion: string, Cloud Run currently ignores this parameter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800306 kind: string, Cloud Run currently ignores this parameter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700307 x__xgafv: string, V1 error format.
308 Allowed values
309 1 - v1 error format
310 2 - v2 error format
311
312Returns:
313 An object of the form:
314
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700315 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="get">get(name, x__xgafv=None)</code>
321 <pre>Rpc to get information about a cloudpubsubsource.
322
323Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700324 name: string, The name of the cloudpubsubsource being retrieved. If needed, replace {namespace_id} with the project ID. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700325 x__xgafv: string, V1 error format.
326 Allowed values
327 1 - v1 error format
328 2 - v2 error format
329
330Returns:
331 An object of the form:
332
333 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800334 &quot;spec&quot;: { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.
335 &quot;ackDeadline&quot;: &quot;A String&quot;, # AckDeadline is the default maximum time after a subscriber receives a message before the subscriber should acknowledge the message. Defaults to 30 seconds (&#x27;30s&#x27;). +optional
336 &quot;pubsubSecret&quot;: { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # CloudPubSubSourceSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret.
337 &quot;key&quot;: &quot;A String&quot;, # 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.
338 &quot;optional&quot;: 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
339 &quot;name&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod&#x27;s namespace to select from.
340 &quot;localObjectReference&quot;: { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the &quot;name&quot; field instead.
341 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
342 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800343 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800344 &quot;secret&quot;: { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional
345 &quot;key&quot;: &quot;A String&quot;, # 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.
346 &quot;optional&quot;: 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
347 &quot;name&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod&#x27;s namespace to select from.
348 &quot;localObjectReference&quot;: { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the &quot;name&quot; field instead.
349 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
350 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800351 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800352 &quot;project&quot;: &quot;A String&quot;, # Project is the ID of the Google Cloud Project that the CloudPubSubSource Topic exists in. If omitted, defaults to same as the cluster. +optional
353 &quot;retainAckedMessages&quot;: 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.
354 &quot;topic&quot;: &quot;A String&quot;, # 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 &#x27;laconia&#x27;, not &#x27;projects/my-proj/topics/laconia&#x27;.
355 &quot;retentionDuration&quot;: &quot;A String&quot;, # 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 (&#x27;7d&#x27;). +optional
356 &quot;sink&quot;: { # Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink.
357 &quot;uri&quot;: &quot;A String&quot;, # 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
358 &quot;ref&quot;: { # ObjectReference contains enough information to let you inspect or modify the referred object. # ObjectReference points to an Addressable. + optional
359 &quot;namespace&quot;: &quot;A String&quot;, # Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional
360 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
361 &quot;fieldPath&quot;: &quot;A String&quot;, # 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: &quot;spec.containers{name}&quot; (where &quot;name&quot; refers to the name of the container that triggered the event) or if no container name is specified &quot;spec.containers[2]&quot; (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.
362 &quot;resourceVersion&quot;: &quot;A String&quot;, # 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
363 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional
364 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional
365 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent. +optional
366 },
367 },
368 &quot;ceOverrides&quot;: { # CloudEventOverrides defines arguments for a Source that control the output format of the CloudEvents produced by the Source. # CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional
369 &quot;extensions&quot;: { # Extensions specify what attribute are added or overridden on the outbound event. Each `Extensions` key-value pair are set on the event as an attribute extension independently. +optional
370 &quot;a_key&quot;: &quot;A String&quot;,
371 },
372 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800373 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800374 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;events.cloud.google.com/v1alpha1&quot;.
375 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CloudPubSubSource.
376 &quot;uid&quot;: &quot;A String&quot;, # 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 +optional
377 &quot;creationTimestamp&quot;: &quot;A String&quot;, # 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 +optional
378 &quot;namespace&quot;: &quot;A String&quot;, # 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.
379 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
380 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
381 &quot;labels&quot;: { # 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 +optional
Bu Sun Kim65020912020-05-20 12:08:20 -0700382 &quot;a_key&quot;: &quot;A String&quot;,
383 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800384 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional
385 { # 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.
386 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; 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 &quot;delete&quot; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
387 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
388 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
389 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
390 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
391 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
392 },
393 ],
394 &quot;name&quot;: &quot;A String&quot;, # 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
395 &quot;clusterName&quot;: &quot;A String&quot;, # 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
396 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. 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 +optional string generateName = 2;
397 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # 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 +optional
398 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run. 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. +optional +patchStrategy=merge
399 &quot;A String&quot;,
400 ],
401 &quot;deletionGracePeriodSeconds&quot;: 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
402 &quot;annotations&quot;: { # 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
403 &quot;a_key&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700404 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800405 &quot;resourceVersion&quot;: &quot;A String&quot;, # 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 +optional
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700406 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800407 &quot;status&quot;: { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional
408 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the CloudPubSubSource that was last processed by the controller.
409 &quot;conditions&quot;: [ # Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource.
410 { # Condition defines a generic condition for a Resource
411 &quot;reason&quot;: &quot;A String&quot;, # Optional. One-word CamelCase reason for the condition&#x27;s last transition.
412 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Optional. Last time the condition transitioned from one status to another.
413 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
414 &quot;severity&quot;: &quot;A String&quot;, # Optional. How to interpret failures of this condition, one of Error, Warning, Info
415 &quot;type&quot;: &quot;A String&quot;, # 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: * &quot;Ready&quot;: True when the Resource is ready.
416 &quot;message&quot;: &quot;A String&quot;, # Optional. Human readable message indicating details about the current status.
417 },
418 ],
419 &quot;sinkUri&quot;: &quot;A String&quot;, # SinkURI is the current active sink URI that has been configured for the Source. +optional
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800420 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800421 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;CloudPubSubSource&quot;.
422 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700423</div>
424
425<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800426 <code class="details" id="list">list(parent, resourceVersion=None, limit=None, continue=None, fieldSelector=None, watch=None, includeUninitialized=None, labelSelector=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700427 <pre>Rpc to list cloudpubsubsources.
428
429Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700430 parent: string, The project ID or project number from which the cloudpubsubsources should be listed. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700431 resourceVersion: string, The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800432 limit: integer, The maximum number of records that should be returned.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800433 continue: string, Optional encoded string to continue paging.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800434 fieldSelector: string, Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. &#x27;metadata.name%3Dlorem&#x27;. Not currently used by Cloud Run.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800435 watch: boolean, Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.
436 includeUninitialized: boolean, Not currently used by Cloud Run.
437 labelSelector: string, Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.
Bu Sun Kim65020912020-05-20 12:08:20 -0700438 x__xgafv: string, V1 error format.
439 Allowed values
440 1 - v1 error format
441 2 - v2 error format
442
443Returns:
444 An object of the form:
445
446 { # ListCloudPubSubSourcesResponse is a list of CloudPubSubSource resources.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800447 &quot;metadata&quot;: { # ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. # Metadata associated with this CloudPubSubSource list.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800448 &quot;resourceVersion&quot;: &quot;A String&quot;, # String that identifies the server&#x27;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
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800449 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800450 &quot;continue&quot;: &quot;A String&quot;, # 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.
451 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800452 &quot;items&quot;: [ # List of CloudPubSubSources.
453 {
454 &quot;spec&quot;: { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.
455 &quot;ackDeadline&quot;: &quot;A String&quot;, # AckDeadline is the default maximum time after a subscriber receives a message before the subscriber should acknowledge the message. Defaults to 30 seconds (&#x27;30s&#x27;). +optional
456 &quot;pubsubSecret&quot;: { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # CloudPubSubSourceSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret.
457 &quot;key&quot;: &quot;A String&quot;, # 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.
458 &quot;optional&quot;: 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
459 &quot;name&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod&#x27;s namespace to select from.
460 &quot;localObjectReference&quot;: { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the &quot;name&quot; field instead.
461 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
462 },
463 },
464 &quot;secret&quot;: { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional
465 &quot;key&quot;: &quot;A String&quot;, # 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.
466 &quot;optional&quot;: 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
467 &quot;name&quot;: &quot;A String&quot;, # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod&#x27;s namespace to select from.
468 &quot;localObjectReference&quot;: { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the &quot;name&quot; field instead.
469 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
470 },
471 },
472 &quot;project&quot;: &quot;A String&quot;, # Project is the ID of the Google Cloud Project that the CloudPubSubSource Topic exists in. If omitted, defaults to same as the cluster. +optional
473 &quot;retainAckedMessages&quot;: 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.
474 &quot;topic&quot;: &quot;A String&quot;, # 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 &#x27;laconia&#x27;, not &#x27;projects/my-proj/topics/laconia&#x27;.
475 &quot;retentionDuration&quot;: &quot;A String&quot;, # 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 (&#x27;7d&#x27;). +optional
476 &quot;sink&quot;: { # Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink.
477 &quot;uri&quot;: &quot;A String&quot;, # 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
478 &quot;ref&quot;: { # ObjectReference contains enough information to let you inspect or modify the referred object. # ObjectReference points to an Addressable. + optional
479 &quot;namespace&quot;: &quot;A String&quot;, # Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional
480 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
481 &quot;fieldPath&quot;: &quot;A String&quot;, # 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: &quot;spec.containers{name}&quot; (where &quot;name&quot; refers to the name of the container that triggered the event) or if no container name is specified &quot;spec.containers[2]&quot; (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.
482 &quot;resourceVersion&quot;: &quot;A String&quot;, # 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
483 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional
484 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional
485 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent. +optional
486 },
487 },
488 &quot;ceOverrides&quot;: { # CloudEventOverrides defines arguments for a Source that control the output format of the CloudEvents produced by the Source. # CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional
489 &quot;extensions&quot;: { # Extensions specify what attribute are added or overridden on the outbound event. Each `Extensions` key-value pair are set on the event as an attribute extension independently. +optional
490 &quot;a_key&quot;: &quot;A String&quot;,
491 },
492 },
493 },
494 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;events.cloud.google.com/v1alpha1&quot;.
495 &quot;metadata&quot;: { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CloudPubSubSource.
496 &quot;uid&quot;: &quot;A String&quot;, # 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 +optional
497 &quot;creationTimestamp&quot;: &quot;A String&quot;, # 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 +optional
498 &quot;namespace&quot;: &quot;A String&quot;, # 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.
499 &quot;generation&quot;: 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
500 &quot;selfLink&quot;: &quot;A String&quot;, # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;
501 &quot;labels&quot;: { # 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 +optional
502 &quot;a_key&quot;: &quot;A String&quot;,
503 },
504 &quot;ownerReferences&quot;: [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional
505 { # 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.
506 &quot;blockOwnerDeletion&quot;: True or False, # If true, AND if the owner has the &quot;foregroundDeletion&quot; 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 &quot;delete&quot; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
507 &quot;uid&quot;: &quot;A String&quot;, # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
508 &quot;controller&quot;: True or False, # If true, this reference points to the managing controller. +optional
509 &quot;name&quot;: &quot;A String&quot;, # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
510 &quot;apiVersion&quot;: &quot;A String&quot;, # API version of the referent.
511 &quot;kind&quot;: &quot;A String&quot;, # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
512 },
513 ],
514 &quot;name&quot;: &quot;A String&quot;, # 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
515 &quot;clusterName&quot;: &quot;A String&quot;, # 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
516 &quot;generateName&quot;: &quot;A String&quot;, # Not currently supported by Cloud Run. 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 +optional string generateName = 2;
517 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # 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 +optional
518 &quot;finalizers&quot;: [ # Not currently supported by Cloud Run. 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. +optional +patchStrategy=merge
519 &quot;A String&quot;,
520 ],
521 &quot;deletionGracePeriodSeconds&quot;: 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
522 &quot;annotations&quot;: { # 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
523 &quot;a_key&quot;: &quot;A String&quot;,
524 },
525 &quot;resourceVersion&quot;: &quot;A String&quot;, # 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 +optional
526 },
527 &quot;status&quot;: { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional
528 &quot;observedGeneration&quot;: 42, # ObservedGeneration is the &#x27;Generation&#x27; of the CloudPubSubSource that was last processed by the controller.
529 &quot;conditions&quot;: [ # Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource.
530 { # Condition defines a generic condition for a Resource
531 &quot;reason&quot;: &quot;A String&quot;, # Optional. One-word CamelCase reason for the condition&#x27;s last transition.
532 &quot;lastTransitionTime&quot;: &quot;A String&quot;, # Optional. Last time the condition transitioned from one status to another.
533 &quot;status&quot;: &quot;A String&quot;, # Status of the condition, one of True, False, Unknown.
534 &quot;severity&quot;: &quot;A String&quot;, # Optional. How to interpret failures of this condition, one of Error, Warning, Info
535 &quot;type&quot;: &quot;A String&quot;, # 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: * &quot;Ready&quot;: True when the Resource is ready.
536 &quot;message&quot;: &quot;A String&quot;, # Optional. Human readable message indicating details about the current status.
537 },
538 ],
539 &quot;sinkUri&quot;: &quot;A String&quot;, # SinkURI is the current active sink URI that has been configured for the Source. +optional
540 },
541 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource, in this case &quot;CloudPubSubSource&quot;.
542 },
543 ],
544 &quot;kind&quot;: &quot;A String&quot;, # The kind of this resource, in this case &quot;CloudPubSubSourceList&quot;.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800545 &quot;apiVersion&quot;: &quot;A String&quot;, # The API version for this call such as &quot;events.cloud.google.com/v1alpha1&quot;.
546 &quot;unreachable&quot;: [ # Locations that could not be reached.
547 &quot;A String&quot;,
548 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700549 }</pre>
550</div>
551
552</body></html>