Blame - docs/dyn/run_v1alpha1.projects.locations.cloudpubsubsources.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

81

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Creates a new cloudpubsubsource.</p>

83

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

84

<code><a href="#delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

85

<p class="firstline">Rpc to delete a cloudpubsubsource.</p>

86

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

90

<code><a href="#list">list(parent, limit=None, continue=None, includeUninitialized=None, watch=None, fieldSelector=None, resourceVersion=None, labelSelector=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

91

<p class="firstline">Rpc to list cloudpubsubsources.</p>

92

<h3>Method Details</h3>

93

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

94

<code class="details" id="close">close()</code>

95

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

99

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

100

<pre>Creates a new cloudpubsubsource.

101

102

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

103

parent: string, The project ID or project number in which this cloudpubsubsource should be created. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

104

body: object, The request body.

105

The object takes the form of:

106

107

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

108

"kind": "A String", # The kind of resource, in this case "CloudPubSubSource".

109

"status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional

110

"conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource.

111

{ # Condition defines a generic condition for a Resource

112

"status": "A String", # Status of the condition, one of True, False, Unknown.

113

"message": "A String", # Optional. Human readable message indicating details about the current status.

114

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

115

"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.

116

"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.

117

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

118

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

119

],

120

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that was last processed by the controller.

121

"sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the Source. +optional

122

},

123

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

124

"spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.

125

"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

126

"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

127

"ceOverrides": { # 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

128

"extensions": { # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

129

"a_key": "A String",

130

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

131

},

132

"sink": { # Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink.

133

"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

134

"ref": { # ObjectReference contains enough information to let you inspect or modify the referred object. # ObjectReference points to an Addressable. + optional

135

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional

136

"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

137

"uid": "A String", # UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional

138

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional

139

"namespace": "A String", # Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional

140

"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.

141

"apiVersion": "A String", # API version of the referent. +optional

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

142

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

143

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

144

"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'.

145

"pubsubSecret": { # 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.

146

"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

147

"localObjectReference": { # 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 "name" field instead.

148

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

149

},

150

"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.

151

"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.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

152

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

153

"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

154

"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.

155

"secret": { # 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

156

"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

157

"localObjectReference": { # 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 "name" field instead.

158

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

159

},

160

"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.

161

"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.

162

},

163

},

164

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CloudPubSubSource.

165

"creationTimestamp": "A String", # 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

166

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional

167

"resourceVersion": "A String", # 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

168

"generation": 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

169

"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. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional

170

"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

171

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional

172

{ # 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.

173

"apiVersion": "A String", # API version of the referent.

174

"uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

175

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional

176

"controller": True or False, # If true, this reference points to the managing controller. +optional

177

"name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

178

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

179

},

180

],

181

"selfLink": "A String", # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;

182

"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.

183

"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

184

"labels": { # 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

185

"a_key": "A String",

186

},

187

"generateName": "A String", # 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;

188

"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

189

"a_key": "A String",

190

},

191

"finalizers": [ # 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

192

"A String",

193

],

194

"deletionTimestamp": "A String", # 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

195

},

196

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

197

198

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

205

206

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

207

"kind": "A String", # The kind of resource, in this case "CloudPubSubSource".

208

"status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional

209

"conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource.

210

{ # Condition defines a generic condition for a Resource

211

"status": "A String", # Status of the condition, one of True, False, Unknown.

212

"message": "A String", # Optional. Human readable message indicating details about the current status.

213

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

214

"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.

215

"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.

216

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

217

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

218

],

219

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that was last processed by the controller.

220

"sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the Source. +optional

221

},

222

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

223

"spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.

224

"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

225

"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

226

"ceOverrides": { # 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

227

"extensions": { # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

228

"a_key": "A String",

229

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

230

},

231

"sink": { # Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink.

232

"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

233

"ref": { # ObjectReference contains enough information to let you inspect or modify the referred object. # ObjectReference points to an Addressable. + optional

234

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional

235

"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

236

"uid": "A String", # UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional

237

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional

238

"namespace": "A String", # Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional

239

"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.

240

"apiVersion": "A String", # API version of the referent. +optional

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

241

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

242

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

243

"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'.

244

"pubsubSecret": { # 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.

245

"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

246

"localObjectReference": { # 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 "name" field instead.

247

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

248

},

249

"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.

250

"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.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

251

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

252

"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

253

"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.

254

"secret": { # 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

255

"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

256

"localObjectReference": { # 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 "name" field instead.

257

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

258

},

259

"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.

260

"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.

261

},

262

},

263

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CloudPubSubSource.

264

"creationTimestamp": "A String", # 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

265

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional

266

"resourceVersion": "A String", # 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

267

"generation": 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

268

"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. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional

269

"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

270

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional

271

{ # 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.

272

"apiVersion": "A String", # API version of the referent.

273

"uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

274

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional

275

"controller": True or False, # If true, this reference points to the managing controller. +optional

276

"name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

277

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

278

},

279

],

280

"selfLink": "A String", # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;

281

"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.

282

"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

283

"labels": { # 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

284

"a_key": "A String",

285

},

286

"generateName": "A String", # 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;

287

"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

288

"a_key": "A String",

289

},

290

"finalizers": [ # 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

291

"A String",

292

],

293

"deletionTimestamp": "A String", # 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

294

},

295

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

299

<code class="details" id="delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

<pre>Rpc to delete a cloudpubsubsource.

301

302

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

303

name: string, The name of the cloudpubsubsource being deleted. If needed, replace {namespace_id} with the project ID. (required)

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

304

apiVersion: string, Cloud Run currently ignores this parameter.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

305

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.

306

kind: string, Cloud Run currently ignores this parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

307

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

314

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

315

{ # 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 Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

321

<pre>Rpc to get information about a cloudpubsubsource.

322

323

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

324

name: string, The name of the cloudpubsubsource being retrieved. If needed, replace {namespace_id} with the project ID. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

325

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

332

333

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

334

"kind": "A String", # The kind of resource, in this case "CloudPubSubSource".

335

"status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional

336

"conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource.

337

{ # Condition defines a generic condition for a Resource

338

"status": "A String", # Status of the condition, one of True, False, Unknown.

339

"message": "A String", # Optional. Human readable message indicating details about the current status.

340

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

341

"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.

342

"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.

343

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

344

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

345

],

346

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that was last processed by the controller.

347

"sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the Source. +optional

348

},

349

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

350

"spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.

351

"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

352

"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

353

"ceOverrides": { # 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

354

"extensions": { # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

355

"a_key": "A String",

356

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

357

},

358

"sink": { # Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink.

359

"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

360

"ref": { # ObjectReference contains enough information to let you inspect or modify the referred object. # ObjectReference points to an Addressable. + optional

361

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional

362

"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

363

"uid": "A String", # UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional

364

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional

365

"namespace": "A String", # Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional

366

"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.

367

"apiVersion": "A String", # API version of the referent. +optional

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

368

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

369

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

370

"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'.

371

"pubsubSecret": { # 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.

372

"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

373

"localObjectReference": { # 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 "name" field instead.

374

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

375

},

376

"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.

377

"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.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

378

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

379

"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

380

"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.

381

"secret": { # 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

382

"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

383

"localObjectReference": { # 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 "name" field instead.

384

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

385

},

386

"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.

387

"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.

388

},

389

},

390

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CloudPubSubSource.

391

"creationTimestamp": "A String", # 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

392

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional

393

"resourceVersion": "A String", # 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

394

"generation": 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

395

"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. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional

396

"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

397

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional

398

{ # 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.

399

"apiVersion": "A String", # API version of the referent.

400

"uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

401

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional

402

"controller": True or False, # If true, this reference points to the managing controller. +optional

403

"name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

404

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

405

},

406

],

407

"selfLink": "A String", # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;

408

"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.

409

"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

410

"labels": { # 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

411

"a_key": "A String",

412

},

413

"generateName": "A String", # 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;

414

"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

415

"a_key": "A String",

416

},

417

"finalizers": [ # 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

418

"A String",

419

],

420

"deletionTimestamp": "A String", # 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

421

},

422

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

426

<code class="details" id="list">list(parent, limit=None, continue=None, includeUninitialized=None, watch=None, fieldSelector=None, resourceVersion=None, labelSelector=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

427

<pre>Rpc to list cloudpubsubsources.

428

429

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

430

parent: string, The project ID or project number from which the cloudpubsubsources should be listed. (required)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

431

limit: integer, The maximum number of records that should be returned.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

432

continue: string, Optional encoded string to continue paging.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

433

includeUninitialized: boolean, Not currently used by Cloud Run.

434

watch: boolean, Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

435

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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

436

resourceVersion: string, The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

437

labelSelector: string, Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

438

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

445

446

{ # ListCloudPubSubSourcesResponse is a list of CloudPubSubSource resources.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

447

"items": [ # List of CloudPubSubSources.

448

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

449

"kind": "A String", # The kind of resource, in this case "CloudPubSubSource".

450

"status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional

451

"conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource.

452

{ # Condition defines a generic condition for a Resource

453

"status": "A String", # Status of the condition, one of True, False, Unknown.

454

"message": "A String", # Optional. Human readable message indicating details about the current status.

455

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

456

"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.

457

"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.

458

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

459

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

460

],

461

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that was last processed by the controller.

462

"sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the Source. +optional

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

463

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

464

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

465

"spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource.

466

"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

467

"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

468

"ceOverrides": { # 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

469

"extensions": { # 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

"a_key": "A String",

},

},

"sink": { # Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink.

474

"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

475

"ref": { # ObjectReference contains enough information to let you inspect or modify the referred object. # ObjectReference points to an Addressable. + optional

476

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional

477

"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

478

"uid": "A String", # UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional

479

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional

480

"namespace": "A String", # Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional

481

"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.

482

"apiVersion": "A String", # API version of the referent. +optional

483

},

484

},

485

"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'.

486

"pubsubSecret": { # 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.

487

"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

488

"localObjectReference": { # 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 "name" field instead.

489

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

490

},

491

"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.

492

"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.

493

},

494

"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

495

"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.

496

"secret": { # 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

497

"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

498

"localObjectReference": { # 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 "name" field instead.

499

"name": "A String", # Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

500

},

501

"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.

502

"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.

503

},

504

},

505

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CloudPubSubSource.

506

"creationTimestamp": "A String", # 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

507

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional

508

"resourceVersion": "A String", # 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

509

"generation": 42, # A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

510

"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. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional

511

"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

512

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional

513

{ # 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.

514

"apiVersion": "A String", # API version of the referent.

515

"uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

516

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional

517

"controller": True or False, # If true, this reference points to the managing controller. +optional

518

"name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

519

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

520

},

521

],

522

"selfLink": "A String", # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4;

523

"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.

524

"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

525

"labels": { # 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

526

"a_key": "A String",

527

},

528

"generateName": "A String", # 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;

529

"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

530

"a_key": "A String",

531

},

532

"finalizers": [ # 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

533

"A String",

534

],

535

"deletionTimestamp": "A String", # 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

536

},

537

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

538

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

539

"metadata": { # 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.

540

"selfLink": "A String", # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional

541

"resourceVersion": "A String", # String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional

542

"continue": "A String", # continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.

543

},

Yoshi Automation Bot