Blame - docs/dyn/run_v1alpha1.namespaces.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-11-24 15:48: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-11-24 15:48:03 -0800

[diff] [blame^]

90

<code><a href="#list">list(parent, watch=None, includeUninitialized=None, limit=None, continue=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-11-24 15:48:03 -0800

[diff] [blame^]

108

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

109

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

110

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

111

"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

112

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

113

"a_key": "A String",

114

},

Bu Sun Kim

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

[diff] [blame]

115

},

Yoshi Automation Bot

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

[diff] [blame^]

116

"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

117

"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

118

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

119

"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

120

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

121

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

122

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

123

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

124

"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

125

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

126

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

127

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

Dmitry Frenkel

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

[diff] [blame]

128

},

Dmitry Frenkel

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

[diff] [blame]

129

},

Yoshi Automation Bot

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

[diff] [blame^]

130

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

131

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

132

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

133

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

134

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

135

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

136

},

137

"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

138

},

139

"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

140

"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

141

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

142

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

143

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

144

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

145

},

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

},

148

},

149

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

150

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

151

"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

152

"a_key": "A String",

153

},

154

"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

155

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

156

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

157

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

158

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

159

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

160

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

161

"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

162

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

163

},

164

],

165

"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

166

"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

167

"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

168

"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

169

"a_key": "A String",

170

},

171

"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

172

"A String",

173

],

174

"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

175

"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

176

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

177

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

178

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

179

"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

180

},

181

"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

182

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

183

{ # Condition defines a generic condition for a Resource

184

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

185

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

186

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

187

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

188

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

189

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

190

},

191

],

192

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

193

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

194

},

195

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

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-11-24 15:48:03 -0800

[diff] [blame^]

207

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

208

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

209

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

210

"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

211

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

212

"a_key": "A String",

213

},

Bu Sun Kim

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

[diff] [blame]

214

},

Yoshi Automation Bot

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

[diff] [blame^]

215

"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

216

"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

217

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

218

"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

219

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

220

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

221

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

222

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

223

"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

224

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

225

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

226

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

Dmitry Frenkel

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

[diff] [blame]

227

},

Dmitry Frenkel

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

[diff] [blame]

228

},

Yoshi Automation Bot

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

[diff] [blame^]

229

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

230

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

231

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

232

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

233

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

234

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

235

},

236

"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

237

},

238

"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

239

"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

240

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

241

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

242

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

243

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

244

},

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

},

247

},

248

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

249

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

250

"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

251

"a_key": "A String",

252

},

253

"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

254

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

255

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

256

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

257

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

258

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

259

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

260

"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

261

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

262

},

263

],

264

"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

265

"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

266

"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

267

"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

268

"a_key": "A String",

269

},

270

"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

271

"A String",

272

],

273

"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

274

"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

275

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

276

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

277

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

278

"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

279

},

280

"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

281

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

282

{ # Condition defines a generic condition for a Resource

283

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

284

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

285

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

286

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

287

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

288

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

289

},

290

],

291

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

292

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

293

},

294

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

295

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-24 15:48: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-24 15:48:03 -0800

[diff] [blame^]

304

apiVersion: string, Cloud Run currently ignores this parameter.

Bu Sun Kim

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

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

Dmitry Frenkel

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

[diff] [blame]

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-11-24 15:48:03 -0800

[diff] [blame^]

334

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

335

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

336

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

337

"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

338

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

339

"a_key": "A String",

340

},

Bu Sun Kim

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

[diff] [blame]

341

},

Yoshi Automation Bot

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

[diff] [blame^]

342

"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

343

"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

344

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

345

"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

346

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

347

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

348

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

349

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

350

"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

351

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

352

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

353

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

Dmitry Frenkel

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

[diff] [blame]

354

},

Dmitry Frenkel

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

[diff] [blame]

355

},

Yoshi Automation Bot

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

[diff] [blame^]

356

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

357

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

358

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

359

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

360

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

361

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

362

},

363

"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

364

},

365

"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

366

"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

367

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

368

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

369

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

370

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

371

},

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

},

374

},

375

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

376

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

377

"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

378

"a_key": "A String",

379

},

380

"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

381

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

382

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

383

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

384

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

385

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

386

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

387

"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

388

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

389

},

390

],

391

"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

392

"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

393

"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

394

"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

395

"a_key": "A String",

396

},

397

"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

398

"A String",

399

],

400

"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

401

"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

402

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

403

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

404

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

405

"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

406

},

407

"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

408

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

409

{ # Condition defines a generic condition for a Resource

410

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

411

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

412

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

413

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

414

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

415

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

416

},

417

],

418

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

419

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

420

},

421

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

422

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame^]

426

<code class="details" id="list">list(parent, watch=None, includeUninitialized=None, limit=None, continue=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-24 15:48:03 -0800

[diff] [blame^]

431

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

432

includeUninitialized: boolean, Not currently used by Cloud Run.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

433

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

Dmitry Frenkel

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

[diff] [blame]

434

continue: string, Optional encoded string to continue paging.

Yoshi Automation Bot

2020-11-24 15:48: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.

Bu Sun Kim

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

[diff] [blame]

436

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

447

"items": [ # List of CloudPubSubSources.

448

{

Yoshi Automation Bot

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

[diff] [blame^]

449

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

450

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

451

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

452

"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

453

"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-11-16 11:05:03 -0700

[diff] [blame]

454

"a_key": "A String",

455

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

456

},

Yoshi Automation Bot

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

[diff] [blame^]

457

"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

458

"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

459

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

460

"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

461

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

462

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

463

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

464

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

465

"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

466

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

467

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

468

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

469

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

470

},

Yoshi Automation Bot

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

[diff] [blame^]

471

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

472

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

473

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

474

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

475

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

476

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

477

},

478

"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

479

},

480

"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

481

"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

482

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

483

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

484

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

485

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

486

},

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

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

489

},

Yoshi Automation Bot

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

[diff] [blame^]

490

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

491

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

492

"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

493

"a_key": "A String",

494

},

495

"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

496

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

497

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

498

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

499

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

500

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

501

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

502

"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

503

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

504

},

505

],

506

"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

507

"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

508

"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

509

"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

510

"a_key": "A String",

511

},

512

"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

513

"A String",

514

],

515

"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

516

"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

517

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

518

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

519

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

520

"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

521

},

522

"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

523

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

524

{ # Condition defines a generic condition for a Resource

525

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

526

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

527

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

528

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

529

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

530

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

531

},

532

],

533

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

534

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

535

},

536

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

537

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

538

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

540

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

Yoshi Automation Bot

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

[diff] [blame^]

541

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

542

"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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

543

},

Yoshi Automation Bot