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

78

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

79

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

80

Bu Sun Kim

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

[diff] [blame]

81

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

Bu Sun Kim

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

[diff] [blame]

82

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

83

84

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Rpc to get information about a cloudpubsubsource.</p>

86

Bu Sun Kim

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

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

89

<h3>Method Details</h3>

90

91

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

92

<pre>Creates a new cloudpubsubsource.

93

94

Args:

Bu Sun Kim

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

[diff] [blame]

95

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]

96

body: object, The request body.

97

The object takes the form of:

98

99

{

Bu Sun Kim

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

[diff] [blame]

100

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

101

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

102

"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

103

"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

104

"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

105

"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

106

"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

107

"A String",

108

],

109

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

110

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

111

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

112

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

113

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

114

"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

115

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

116

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

Bu Sun Kim

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

[diff] [blame]

117

},

118

],

Bu Sun Kim

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

[diff] [blame]

119

"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

120

"a_key": "A String",

121

},

122

"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

123

"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

124

"a_key": "A String",

125

},

126

"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

127

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

128

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

129

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

130

"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

Bu Sun Kim

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

[diff] [blame]

131

},

Bu Sun Kim

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

[diff] [blame]

132

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

133

"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

134

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

135

{ # Condition defines a generic condition for a Resource

136

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

137

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

138

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

139

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

140

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

141

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

142

},

143

],

144

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

145

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

146

},

Bu Sun Kim

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

[diff] [blame]

147

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

Bu Sun Kim

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

[diff] [blame]

148

"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

149

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

150

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

151

},

Bu Sun Kim

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

[diff] [blame]

152

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

153

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

154

"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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

155

},

Bu Sun Kim

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

[diff] [blame]

156

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

157

"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

158

"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

159

"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

160

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

161

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

162

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

163

},

Bu Sun Kim

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

[diff] [blame]

164

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

165

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

166

"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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

167

},

Bu Sun Kim

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

[diff] [blame]

168

"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

169

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

170

"a_key": "A String",

171

},

172

},

Bu Sun Kim

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

[diff] [blame]

173

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

174

"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

175

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

176

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

177

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

178

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

179

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

180

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

181

"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

182

"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-05-27 12:20:54 -0700

[diff] [blame]

183

},

Bu Sun Kim

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

[diff] [blame]

184

},

Bu Sun Kim

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

[diff] [blame]

185

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

Bu Sun Kim

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

[diff] [blame]

186

},

Bu Sun Kim

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

[diff] [blame]

187

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

Bu Sun Kim

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

[diff] [blame]

188

}

189

190

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

197

198

{

Bu Sun Kim

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

[diff] [blame]

199

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

200

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

201

"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

202

"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

203

"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

204

"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

205

"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

206

"A String",

207

],

208

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

209

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

210

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

211

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

212

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

213

"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

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

},

217

],

Bu Sun Kim

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

[diff] [blame]

218

"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

219

"a_key": "A String",

220

},

221

"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

222

"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

223

"a_key": "A String",

224

},

225

"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

226

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

227

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

228

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

229

"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

Bu Sun Kim

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

[diff] [blame]

230

},

Bu Sun Kim

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

[diff] [blame]

231

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

232

"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

233

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

234

{ # Condition defines a generic condition for a Resource

235

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

236

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

237

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

238

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

239

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

240

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

241

},

242

],

243

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

244

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

245

},

Bu Sun Kim

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

[diff] [blame]

246

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

Bu Sun Kim

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

[diff] [blame]

247

"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

248

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

249

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

250

},

Bu Sun Kim

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

[diff] [blame]

251

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

252

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

253

"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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

254

},

Bu Sun Kim

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

[diff] [blame]

255

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

256

"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

257

"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

258

"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

259

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

260

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

261

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

262

},

Bu Sun Kim

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

[diff] [blame]

263

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

264

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

265

"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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

266

},

Bu Sun Kim

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

[diff] [blame]

267

"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

268

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

269

"a_key": "A String",

270

},

271

},

Bu Sun Kim

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

[diff] [blame]

272

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

273

"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

274

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

275

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

276

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

277

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

278

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

279

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

280

"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

281

"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-05-27 12:20:54 -0700

[diff] [blame]

282

},

Bu Sun Kim

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

[diff] [blame]

283

},

Bu Sun Kim

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

[diff] [blame]

284

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

Bu Sun Kim

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

[diff] [blame]

285

},

Bu Sun Kim

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

[diff] [blame]

286

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

291

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

Bu Sun Kim

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

[diff] [blame]

292

<pre>Rpc to delete a cloudpubsubsource.

293

294

Args:

Bu Sun Kim

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

[diff] [blame]

295

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

Bu Sun Kim

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

[diff] [blame]

296

apiVersion: string, Cloud Run currently ignores this parameter.

Bu Sun Kim

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

[diff] [blame]

297

kind: string, Cloud Run currently ignores this parameter.

Bu Sun Kim

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

[diff] [blame]

298

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.

Bu Sun Kim

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

[diff] [blame]

299

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

306

Bu Sun Kim

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

[diff] [blame]

307

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

313

<pre>Rpc to get information about a cloudpubsubsource.

314

315

Args:

Bu Sun Kim

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

[diff] [blame]

316

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]

317

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

324

325

{

Bu Sun Kim

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

[diff] [blame]

326

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

327

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

328

"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

329

"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

330

"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

331

"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

332

"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

333

"A String",

334

],

335

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

336

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

337

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

338

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

339

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

340

"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

341

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

342

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

Bu Sun Kim

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

[diff] [blame]

343

},

344

],

Bu Sun Kim

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

[diff] [blame]

345

"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

346

"a_key": "A String",

347

},

348

"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

349

"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

350

"a_key": "A String",

351

},

352

"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

353

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

354

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

355

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

356

"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

Bu Sun Kim

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

[diff] [blame]

357

},

Bu Sun Kim

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

[diff] [blame]

358

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

359

"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

360

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

361

{ # Condition defines a generic condition for a Resource

362

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

363

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

364

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

365

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

366

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

367

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

368

},

369

],

370

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

371

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

372

},

Bu Sun Kim

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

[diff] [blame]

373

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

Bu Sun Kim

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

[diff] [blame]

374

"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

375

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

376

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

377

},

Bu Sun Kim

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

[diff] [blame]

378

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

379

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

380

"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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

381

},

Bu Sun Kim

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

[diff] [blame]

382

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

383

"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

384

"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

385

"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

386

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

387

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

388

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

389

},

Bu Sun Kim

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

[diff] [blame]

390

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

391

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

392

"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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

393

},

Bu Sun Kim

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

[diff] [blame]

394

"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

395

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

396

"a_key": "A String",

397

},

398

},

Bu Sun Kim

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

[diff] [blame]

399

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

400

"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

401

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

402

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

403

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

404

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

405

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

406

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

407

"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

408

"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-05-27 12:20:54 -0700

[diff] [blame]

409

},

Bu Sun Kim

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

[diff] [blame]

410

},

Bu Sun Kim

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

[diff] [blame]

411

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

Bu Sun Kim

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

[diff] [blame]

412

},

Bu Sun Kim

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

[diff] [blame]

413

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame]

419

<pre>Rpc to list cloudpubsubsources.

420

421

Args:

Bu Sun Kim

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

[diff] [blame]

422

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

Bu Sun Kim

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

[diff] [blame]

423

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

Bu Sun Kim

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

[diff] [blame]

424

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

425

continue: string, Optional encoded string to continue paging.

426

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

427

includeUninitialized: boolean, Not currently used by Cloud Run.

428

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.

429

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-05-20 12:08:20 -0700

[diff] [blame]

430

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

437

438

{ # ListCloudPubSubSourcesResponse is a list of CloudPubSubSource resources.

Bu Sun Kim

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

[diff] [blame]

439

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

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

"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

443

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

444

},

445

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

Bu Sun Kim

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

[diff] [blame]

446

"unreachable": [ # Locations that could not be reached.

447

"A String",

448

],

Bu Sun Kim

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

[diff] [blame]

449

"items": [ # List of CloudPubSubSources.

450

{

Bu Sun Kim

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

[diff] [blame]

451

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

452

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

453

"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

454

"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

455

"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

456

"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

457

"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

458

"A String",

459

],

460

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

461

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

462

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

463

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

464

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

465

"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

466

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

467

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

Bu Sun Kim

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

[diff] [blame]

468

},

469

],

Bu Sun Kim

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

[diff] [blame]

470

"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

471

"a_key": "A String",

472

},

473

"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

474

"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

475

"a_key": "A String",

476

},

477

"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

478

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

479

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

480

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

481

"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

Bu Sun Kim

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

[diff] [blame]

482

},

Bu Sun Kim

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

[diff] [blame]

483

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

484

"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

485

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

486

{ # Condition defines a generic condition for a Resource

487

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

488

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

489

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

490

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

491

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

492

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

493

},

494

],

495

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

496

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

497

},

Bu Sun Kim

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

[diff] [blame]

498

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

Bu Sun Kim

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

[diff] [blame]

499

"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

500

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

501

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

502

},

Bu Sun Kim

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

[diff] [blame]

503

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

504

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

505

"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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

506

},

Bu Sun Kim

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

[diff] [blame]

507

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

508

"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

509

"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

510

"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

511

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

512

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

513

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

514

},

Bu Sun Kim

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

[diff] [blame]

515

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

516

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

517

"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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

518

},

Bu Sun Kim

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

[diff] [blame]

519

"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

520

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

521

"a_key": "A String",

522

},

523

},

Bu Sun Kim

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

[diff] [blame]

524

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

525

"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

526

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

527

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

528

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

529

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

530

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

531

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

532

"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

533

"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-05-27 12:20:54 -0700

[diff] [blame]

534

},

Bu Sun Kim

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

[diff] [blame]

535

},

Bu Sun Kim

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

[diff] [blame]

536

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

Bu Sun Kim

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

[diff] [blame]

537

},

Bu Sun Kim