Blame - docs/dyn/run_v1alpha1.namespaces.cloudschedulersources.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 cloudschedulersource.</p>

83

Yoshi Automation Bot

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

[diff] [blame]

84

<code><a href="#delete">delete(name, propagationPolicy=None, kind=None, apiVersion=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 cloudschedulersource.</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 cloudschedulersource.</p>

89

Yoshi Automation Bot

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

[diff] [blame]

90

<code><a href="#list">list(parent, watch=None, includeUninitialized=None, continue=None, resourceVersion=None, fieldSelector=None, labelSelector=None, limit=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 cloudschedulersources.</p>

92

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Rpc to replace a cloudschedulersource. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.</p>

Bu Sun Kim

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

[diff] [blame]

95

<h3>Method Details</h3>

96

Dmitry Frenkel

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

[diff] [blame]

97

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

98

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

102

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

103

<pre>Creates a new cloudschedulersource.

104

105

Args:

Bu Sun Kim

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

body: object, The request body.

108

The object takes the form of:

109

110

{ # The CloudSchedulerSource resource.

Yoshi Automation Bot

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

[diff] [blame]

111

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

112

"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

113

"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

114

"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

115

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

116

"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

117

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

118

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

119

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

120

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

121

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

122

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

123

"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

124

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

125

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

Dmitry Frenkel

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

[diff] [blame]

126

},

Yoshi Automation Bot

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

[diff] [blame]

127

],

128

"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

129

"a_key": "A String",

130

},

131

"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

132

"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

133

"a_key": "A String",

134

},

135

"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

136

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

137

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

138

"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

139

"A String",

140

],

141

"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

142

},

143

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

144

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

145

"location": "A String", # Location to create the Scheduler job in.

146

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

147

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.

148

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

Bu Sun Kim

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

[diff] [blame]

149

},

Yoshi Automation Bot

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

[diff] [blame]

150

"name": "A String", # Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod's namespace to select from.

151

"key": "A String", # Cloud Run fully managed: not supported Cloud Run on GKE: supported The key of the secret to select from. Must be a valid secret key.

152

"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

153

},

154

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

155

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

156

"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

157

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

158

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

159

"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

160

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

161

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

162

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

163

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

164

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

Bu Sun Kim

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

[diff] [blame]

165

},

166

},

Yoshi Automation Bot

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

[diff] [blame]

167

"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

168

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

169

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

170

},

171

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

172

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

173

"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

174

},

175

"data": "A String", # Data to send in the payload of the Event.

176

"schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run every minute.

177

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

178

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

[diff] [blame]

179

"a_key": "A String",

180

},

Yoshi Automation Bot

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

[diff] [blame]

181

},

182

},

183

"status": { # CloudSchedulerSourceStatus represents the current state of a CloudSchedulerSource. # Status represents the current state of the CloudSchedulerSource. This data may be out of date.

184

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

185

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

186

"conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current state of the CloudSchedulerSource.

187

{ # Condition defines a generic condition for a Resource

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

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

190

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

191

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

192

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

193

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

Bu Sun Kim

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

[diff] [blame]

194

},

Yoshi Automation Bot

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

[diff] [blame]

195

],

196

},

197

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

198

}

Bu Sun Kim

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

[diff] [blame]

199

200

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

207

208

{ # The CloudSchedulerSource resource.

Yoshi Automation Bot

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

[diff] [blame]

209

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

210

"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

211

"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

212

"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

213

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

214

"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

215

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

216

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

217

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

218

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

219

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

220

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

221

"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

222

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

223

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

Dmitry Frenkel

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

[diff] [blame]

224

},

Yoshi Automation Bot

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

[diff] [blame]

225

],

226

"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

227

"a_key": "A String",

228

},

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

230

"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

231

"a_key": "A String",

232

},

233

"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

234

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

235

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

236

"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

237

"A String",

238

],

239

"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

240

},

241

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

242

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

243

"location": "A String", # Location to create the Scheduler job in.

244

"pubsubSecret": { # Cloud Run fully managed: not supported Cloud Run on GKE: supported SecretKeySelector selects a key of a Secret. # CloudPubSubSourceSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret.

245

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

246

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

Bu Sun Kim

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

[diff] [blame]

247

},

Yoshi Automation Bot

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

[diff] [blame]

248

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

249

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

250

"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

251

},

252

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

253

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

254

"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

255

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

256

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

257

"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

258

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

259

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

260

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

261

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

262

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

Bu Sun Kim

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

[diff] [blame]

263

},

264

},

Yoshi Automation Bot

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

[diff] [blame]

265

"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

266

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

267

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

268

},

269

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

270

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

271

"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

272

},

273

"data": "A String", # Data to send in the payload of the Event.

274

"schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run every minute.

275

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

276

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

277

"a_key": "A String",

278

},

Yoshi Automation Bot

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

[diff] [blame]

279

},

280

},

281

"status": { # CloudSchedulerSourceStatus represents the current state of a CloudSchedulerSource. # Status represents the current state of the CloudSchedulerSource. This data may be out of date.

282

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

283

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

284

"conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current state of the CloudSchedulerSource.

285

{ # Condition defines a generic condition for a Resource

286

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

287

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

288

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

289

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

290

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

291

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

Bu Sun Kim

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

[diff] [blame]

292

},

Yoshi Automation Bot

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

[diff] [blame]

293

],

294

},

295

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

296

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

300

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

Bu Sun Kim

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

[diff] [blame]

301

<pre>Rpc to delete a cloudschedulersource.

302

303

Args:

Bu Sun Kim

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

[diff] [blame]

304

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

Bu Sun Kim

2020-11-16 11:05:03 -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.

Yoshi Automation Bot

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

[diff] [blame]

306

kind: string, Cloud Run currently ignores this parameter.

307

apiVersion: string, Cloud Run currently ignores this parameter.

Bu Sun Kim

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

[diff] [blame]

308

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

315

Bu Sun Kim

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

[diff] [blame]

316

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

322

<pre>Rpc to get information about a cloudschedulersource.

323

324

Args:

Bu Sun Kim

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

[diff] [blame]

325

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

Bu Sun Kim

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

[diff] [blame]

326

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

333

334

{ # The CloudSchedulerSource resource.

Yoshi Automation Bot

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

[diff] [blame]

335

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

336

"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

337

"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

338

"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

339

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

340

"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

341

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

342

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

343

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

344

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

345

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

346

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

347

"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

348

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

349

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

Dmitry Frenkel

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

[diff] [blame]

350

},

Yoshi Automation Bot

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

[diff] [blame]

351

],

352

"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

353

"a_key": "A String",

354

},

355

"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

356

"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

357

"a_key": "A String",

358

},

359

"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

360

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

361

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

362

"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

363

"A String",

364

],

365

"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

366

},

367

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

368

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

369

"location": "A String", # Location to create the Scheduler job in.

370

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

371

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

372

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

Bu Sun Kim

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

[diff] [blame]

373

},

Yoshi Automation Bot

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

[diff] [blame]

374

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

375

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

376

"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

377

},

378

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

379

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

380

"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

381

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

382

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

383

"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

384

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

385

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

386

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

387

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

388

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

Bu Sun Kim

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

[diff] [blame]

389

},

390

},

Yoshi Automation Bot

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

[diff] [blame]

391

"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

392

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

393

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

394

},

395

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

396

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

397

"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

398

},

399

"data": "A String", # Data to send in the payload of the Event.

400

"schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run every minute.

401

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

402

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

403

"a_key": "A String",

404

},

Yoshi Automation Bot

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

[diff] [blame]

405

},

406

},

407

"status": { # CloudSchedulerSourceStatus represents the current state of a CloudSchedulerSource. # Status represents the current state of the CloudSchedulerSource. This data may be out of date.

408

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

409

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

410

"conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current state of the CloudSchedulerSource.

411

{ # Condition defines a generic condition for a Resource

412

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

413

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

414

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

415

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

416

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

417

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

Bu Sun Kim

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

[diff] [blame]

418

},

Yoshi Automation Bot

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

[diff] [blame]

419

],

420

},

421

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

422

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

426

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

Bu Sun Kim

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

[diff] [blame]

427

<pre>Rpc to list cloudschedulersources.

428

429

Args:

Bu Sun Kim

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

[diff] [blame]

430

parent: string, Required. The project ID or project number from which the cloudschedulersources 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.

Bu Sun Kim

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

[diff] [blame]

432

includeUninitialized: boolean, Not currently used by Cloud Run.

Yoshi Automation Bot

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

[diff] [blame]

433

continue: string, Optional encoded string to continue paging.

Yoshi Automation Bot

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

[diff] [blame]

434

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

Yoshi Automation Bot

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

Yoshi Automation Bot

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

[diff] [blame]

436

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

Bu Sun Kim

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

[diff] [blame]

437

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

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

Bu Sun Kim

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

[diff] [blame]

446

{ # ListCloudSchedulerSourcesResponse is a list of CloudSchedulerSource resources.

Yoshi Automation Bot

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

[diff] [blame]

447

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

Bu Sun Kim

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

[diff] [blame]

448

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

449

"A String",

450

],

Yoshi Automation Bot

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

[diff] [blame]

451

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

452

"items": [ # List of CloudSchedulerSources.

453

{ # The CloudSchedulerSource resource.

454

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

455

"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

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

"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

458

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

459

"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

460

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

461

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

462

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

463

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

464

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

465

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

466

"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

467

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

468

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

469

},

470

],

471

"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

472

"a_key": "A String",

473

},

474

"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

475

"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

476

"a_key": "A String",

477

},

478

"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

479

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

480

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

481

"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

482

"A String",

483

],

484

"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

485

},

486

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

487

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

488

"location": "A String", # Location to create the Scheduler job in.

489

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

490

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

491

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

492

},

493

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

494

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

495

"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

496

},

497

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

498

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

499

"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

500

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

501

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

502

"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

503

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

504

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

505

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

506

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

507

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

508

},

509

},

510

"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

511

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

512

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

513

},

514

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

515

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

516

"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

517

},

518

"data": "A String", # Data to send in the payload of the Event.

519

"schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run every minute.

520

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

521

"extensions": { # Extensions specify what attribute are added or overridden on the outbound event. Each `Extensions` key-value pair are set on the event as an attribute extension independently. +optional

"a_key": "A String",

},

},

},

"status": { # CloudSchedulerSourceStatus represents the current state of a CloudSchedulerSource. # Status represents the current state of the CloudSchedulerSource. This data may be out of date.

527

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

528

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

529

"conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current state of the CloudSchedulerSource.

530

{ # Condition defines a generic condition for a Resource

531

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

532

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

533

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

534

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

535

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

536

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

},

],

},

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

541

},

542

],

543

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

544

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

545

"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

546

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

547

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

553

<pre>Rpc to replace a cloudschedulersource. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

Bu Sun Kim

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

[diff] [blame]

554

555

Args:

Bu Sun Kim

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

[diff] [blame]

556

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

Bu Sun Kim

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

[diff] [blame]

557

body: object, The request body.

558

The object takes the form of:

559

560

{ # The CloudSchedulerSource resource.

Yoshi Automation Bot

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

[diff] [blame]

561

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

562

"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

563

"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

564

"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

565

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

566

"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

567

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

568

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

569

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

570

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

571

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

572

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

573

"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

574

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

575

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

Dmitry Frenkel

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

[diff] [blame]

576

},

Yoshi Automation Bot

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

[diff] [blame]

577

],

578

"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

579

"a_key": "A String",

580

},

581

"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

582

"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

583

"a_key": "A String",

584

},

585

"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

586

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

587

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

588

"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

589

"A String",

590

],

591

"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

592

},

593

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

594

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

595

"location": "A String", # Location to create the Scheduler job in.

596

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

597

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

598

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

Bu Sun Kim

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

[diff] [blame]

599

},

Yoshi Automation Bot

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

[diff] [blame]

600

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

601

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

602

"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

603

},

604

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

605

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

606

"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

607

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

608

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

609

"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

610

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

611

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

612

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

613

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

614

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

Bu Sun Kim

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

[diff] [blame]

615

},

616

},

Yoshi Automation Bot

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

[diff] [blame]

617

"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

618

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

619

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

620

},

621

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

622

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

623

"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

624

},

625

"data": "A String", # Data to send in the payload of the Event.

626

"schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run every minute.

627

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

628

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

[diff] [blame]

629

"a_key": "A String",

630

},

Yoshi Automation Bot

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

[diff] [blame]

631

},

632

},

633

"status": { # CloudSchedulerSourceStatus represents the current state of a CloudSchedulerSource. # Status represents the current state of the CloudSchedulerSource. This data may be out of date.

634

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

635

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

636

"conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current state of the CloudSchedulerSource.

637

{ # Condition defines a generic condition for a Resource

638

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

639

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

640

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

641

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

642

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

643

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

Bu Sun Kim

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

[diff] [blame]

644

},

Yoshi Automation Bot

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

[diff] [blame]

645

],

646

},

647

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

648

}

Bu Sun Kim

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

[diff] [blame]

649

650

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

657

658

{ # The CloudSchedulerSource resource.

Yoshi Automation Bot

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

[diff] [blame]

659

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

660

"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

661

"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

662

"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

663

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

664

"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

665

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

666

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

667

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

668

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

669

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

670

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

671

"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

672

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

673

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

Dmitry Frenkel

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

[diff] [blame]

674

},

Yoshi Automation Bot

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

[diff] [blame]

675

],

676

"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

677

"a_key": "A String",

678

},

679

"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

680

"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

681

"a_key": "A String",

682

},

683

"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

684

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

685

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

686

"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

687

"A String",

688

],

689

"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

690

},

691

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

692

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

693

"location": "A String", # Location to create the Scheduler job in.

694

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

695

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

696

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

Bu Sun Kim

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

[diff] [blame]

697

},

Yoshi Automation Bot

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

[diff] [blame]

698

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

699

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

700

"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

701

},

702

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

703

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

704

"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

705

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

706

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

707

"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

708

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

709

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

710

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

711

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

712

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

Bu Sun Kim

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

[diff] [blame]

713

},

714

},

Yoshi Automation Bot

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

[diff] [blame]

715

"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

716

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

717

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

718

},

719

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

720

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

721

"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

722

},

723

"data": "A String", # Data to send in the payload of the Event.

724

"schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run every minute.

725

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

726

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

727

"a_key": "A String",

728

},

Yoshi Automation Bot

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

[diff] [blame]

729

},

730

},

731

"status": { # CloudSchedulerSourceStatus represents the current state of a CloudSchedulerSource. # Status represents the current state of the CloudSchedulerSource. This data may be out of date.

732

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

733

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

734

"conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current state of the CloudSchedulerSource.

735

{ # Condition defines a generic condition for a Resource

736

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

737

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

738

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

739

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

740

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

741

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

Bu Sun Kim