| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="run_v1alpha1.html">Cloud Run API</a> . <a href="run_v1alpha1.namespaces.html">namespaces</a> . <a href="run_v1alpha1.namespaces.cloudschedulersources.html">cloudschedulersources</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a new cloudschedulersource.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 81 | <code><a href="#delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <p class="firstline">Rpc to delete a cloudschedulersource.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Rpc to get information about a cloudschedulersource.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(parent, watch=None, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, continue=None, limit=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 88 | <p class="firstline">Rpc to list cloudschedulersources.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#replaceCloudSchedulerSource">replaceCloudSchedulerSource(name, body=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Rpc to replace a cloudschedulersource.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 95 | <pre>Creates a new cloudschedulersource. |
| 96 | |
| 97 | Args: |
| 98 | parent: string, Required. The project ID or project number in which this cloudschedulersource should |
| 99 | be created. (required) |
| 100 | body: object, The request body. |
| 101 | The object takes the form of: |
| 102 | |
| 103 | { # The CloudSchedulerSource resource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 104 | "status": { # CloudSchedulerSourceStatus represents the current state of a # Status represents the current state of the CloudSchedulerSource. This data |
| 105 | # may be out of date. |
| 106 | # CloudSchedulerSource. |
| 107 | "conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current |
| 108 | # state of the CloudSchedulerSource. |
| 109 | { # Condition defines a generic condition for a Resource |
| 110 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 111 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 112 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 113 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 114 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 115 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 116 | # See also: |
| 117 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 118 | # Types common to all resources include: |
| 119 | # * "Ready": True when the Resource is ready. |
| 120 | }, |
| 121 | ], |
| 122 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudSchedulerSource that |
| 123 | # was last processed by the controller. |
| 124 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 125 | # Source. |
| 126 | }, |
| 127 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 128 | "spec": { # The desired state of the CloudSchedulerSource. # Spec defines the desired state of the CloudSchedulerSource. |
| 129 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 130 | # modifications of the event sent to the sink. |
| 131 | # format of the CloudEvents produced by the Source. |
| 132 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 133 | # event. Each `Extensions` key-value pair are set on the event as an |
| 134 | # attribute extension independently. |
| 135 | # +optional |
| 136 | "a_key": "A String", |
| 137 | }, |
| 138 | }, |
| 139 | "schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run |
| 140 | # every minute. |
| 141 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 142 | # If not specified, defaults to: |
| 143 | # Name: google-cloud-key |
| 144 | # Key: key.json |
| 145 | # |
| 146 | # Cloud Run on GKE: supported |
| 147 | # |
| 148 | # SecretKeySelector selects a key of a Secret. |
| 149 | "optional": True or False, # Cloud Run fully managed: not supported |
| 150 | # |
| 151 | # Cloud Run on GKE: supported |
| 152 | # |
| 153 | # Specify whether the Secret or its key must be defined |
| 154 | # +optional |
| 155 | "key": "A String", # Cloud Run fully managed: not supported |
| 156 | # |
| 157 | # Cloud Run on GKE: supported |
| 158 | # |
| 159 | # The key of the secret to select from. Must be a valid secret key. |
| 160 | "name": "A String", # Cloud Run fully managed: not supported |
| 161 | # |
| 162 | # Cloud Run on GKE: supported |
| 163 | # |
| 164 | # The name of the secret in the pod's namespace to select from. |
| 165 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 166 | # directly into the message. Use the "name" field instead. |
| 167 | # referenced object inside the same namespace. |
| 168 | "name": "A String", # Name of the referent. |
| 169 | # More info: |
| 170 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 171 | }, |
| 172 | }, |
| 173 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 174 | # Topic exists in. If omitted, defaults to same as the cluster. |
| 175 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 176 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 177 | # |
| 178 | # Cloud Run on GKE: supported |
| 179 | # |
| 180 | # SecretKeySelector selects a key of a Secret. |
| 181 | "optional": True or False, # Cloud Run fully managed: not supported |
| 182 | # |
| 183 | # Cloud Run on GKE: supported |
| 184 | # |
| 185 | # Specify whether the Secret or its key must be defined |
| 186 | # +optional |
| 187 | "key": "A String", # Cloud Run fully managed: not supported |
| 188 | # |
| 189 | # Cloud Run on GKE: supported |
| 190 | # |
| 191 | # The key of the secret to select from. Must be a valid secret key. |
| 192 | "name": "A String", # Cloud Run fully managed: not supported |
| 193 | # |
| 194 | # Cloud Run on GKE: supported |
| 195 | # |
| 196 | # The name of the secret in the pod's namespace to select from. |
| 197 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 198 | # directly into the message. Use the "name" field instead. |
| 199 | # referenced object inside the same namespace. |
| 200 | "name": "A String", # Name of the referent. |
| 201 | # More info: |
| 202 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 203 | }, |
| 204 | }, |
| 205 | "location": "A String", # Location to create the Scheduler job in. |
| 206 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 207 | # URI directly to use as the sink. |
| 208 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 209 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 210 | # appended to the path of the resulting URL from the Addressable. |
| 211 | # + optional |
| 212 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 213 | # + optional |
| 214 | # referred object. |
| 215 | "apiVersion": "A String", # API version of the referent. |
| 216 | # +optional |
| 217 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 218 | # More info: |
| 219 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 220 | # +optional |
| 221 | "name": "A String", # Name of the referent. |
| 222 | # More info: |
| 223 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 224 | # +optional |
| 225 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 226 | # string should contain a valid JSON/Go field access statement, such as |
| 227 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 228 | # is to a container within a pod, this would take on a value like: |
| 229 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 230 | # that triggered the event) or if no container name is specified |
| 231 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 232 | # chosen only to have some well-defined way of referencing a part of an |
| 233 | # object. |
| 234 | "uid": "A String", # UID of the referent. |
| 235 | # More info: |
| 236 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 237 | # +optional |
| 238 | "namespace": "A String", # Namespace of the referent. |
| 239 | # More info: |
| 240 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 241 | # +optional |
| 242 | "kind": "A String", # Kind of the referent. |
| 243 | # More info: |
| 244 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 245 | # +optional |
| 246 | }, |
| 247 | }, |
| 248 | "data": "A String", # Data to send in the payload of the Event. |
| 249 | }, |
| 250 | "kind": "A String", # The kind of resource, in this case "CloudSchedulerSource". |
| 251 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudSchedulerSource. |
| 252 | # all objects users must create. |
| 253 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 254 | # |
| 255 | # GenerateName is an optional prefix, used by the server, to generate a |
| 256 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 257 | # used, the name returned to the client will be different than the name |
| 258 | # passed. This value will also be combined with a unique suffix. The provided |
| 259 | # value has the same validation rules as the Name field, and may be truncated |
| 260 | # by the length of the suffix required to make the value unique on the |
| 261 | # server. |
| 262 | # |
| 263 | # If this field is specified and the generated name exists, the server will |
| 264 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 265 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 266 | # time allotted, and the client should retry (optionally after the time |
| 267 | # indicated in the Retry-After header). |
| 268 | # |
| 269 | # Applied only if Name is not specified. |
| 270 | # More info: |
| 271 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 272 | # +optional |
| 273 | # string generateName = 2; |
| 274 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 275 | # Is required when creating |
| 276 | # resources, although some resources may allow a client to request the |
| 277 | # generation of an appropriate name automatically. Name is primarily intended |
| 278 | # for creation idempotence and configuration definition. Cannot be updated. |
| 279 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 280 | # +optional |
| 281 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 282 | # |
| 283 | # Number of seconds allowed for this object to gracefully terminate before |
| 284 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 285 | # set. May only be shortened. Read-only. +optional |
| 286 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 287 | # |
| 288 | # The name of the cluster which the object belongs to. |
| 289 | # This is used to distinguish resources with same name and namespace in |
| 290 | # different clusters. This field is not set anywhere right now and apiserver |
| 291 | # is going to ignore it if set in create or update request. +optional |
| 292 | "finalizers": [ # Not currently supported by Cloud Run. |
| 293 | # |
| 294 | # Must be empty before the object is deleted from the registry. Each entry |
| 295 | # is an identifier for the responsible component that will remove the entry |
| 296 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 297 | # in this list can only be removed. |
| 298 | # +optional |
| 299 | # +patchStrategy=merge |
| 300 | "A String", |
| 301 | ], |
| 302 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 303 | # deleted. This field is set by the server when a graceful deletion is |
| 304 | # requested by the user, and is not directly settable by a client. The |
| 305 | # resource is expected to be deleted (no longer visible from resource lists, |
| 306 | # and not reachable by name) after the time in this field, once the |
| 307 | # finalizers list is empty. As long as the finalizers list contains items, |
| 308 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 309 | # be unset or be set further into the future, although it may be shortened or |
| 310 | # the resource may be deleted prior to this time. For example, a user may |
| 311 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 312 | # sending a graceful termination signal to the containers in the pod. After |
| 313 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 314 | # to the container and after cleanup, remove the pod from the API. In the |
| 315 | # presence of network partitions, this object may still exist after this |
| 316 | # timestamp, until an administrator or automated process can determine the |
| 317 | # resource is fully terminated. |
| 318 | # If not set, graceful deletion of the object has not been requested. |
| 319 | # |
| 320 | # Populated by the system when a graceful deletion is requested. |
| 321 | # Read-only. |
| 322 | # More info: |
| 323 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 324 | # +optional |
| 325 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 326 | # been deleted, this object will be garbage collected. |
| 327 | # +optional |
| 328 | { # OwnerReference contains enough information to let you identify an owning |
| 329 | # object. Currently, an owning object must be in the same namespace, so there |
| 330 | # is no namespace field. |
| 331 | "controller": True or False, # If true, this reference points to the managing controller. |
| 332 | # +optional |
| 333 | "kind": "A String", # Kind of the referent. |
| 334 | # More info: |
| 335 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 336 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 337 | # the owner cannot be deleted from the key-value store until this |
| 338 | # reference is removed. |
| 339 | # Defaults to false. |
| 340 | # To set this field, a user needs "delete" permission of the owner, |
| 341 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 342 | # +optional |
| 343 | "apiVersion": "A String", # API version of the referent. |
| 344 | "name": "A String", # Name of the referent. |
| 345 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 346 | "uid": "A String", # UID of the referent. |
| 347 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 348 | }, |
| 349 | ], |
| 350 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 351 | # object was created. It is not guaranteed to be set in happens-before order |
| 352 | # across separate operations. Clients may not set this value. It is |
| 353 | # represented in RFC3339 form and is in UTC. |
| 354 | # |
| 355 | # Populated by the system. |
| 356 | # Read-only. |
| 357 | # Null for lists. |
| 358 | # More info: |
| 359 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 360 | # +optional |
| 361 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 362 | # (scope and select) objects. May match selectors of replication controllers |
| 363 | # and routes. |
| 364 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 365 | # +optional |
| 366 | "a_key": "A String", |
| 367 | }, |
| 368 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 369 | # Populated by the system. Read-only. |
| 370 | # +optional |
| 371 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 372 | # can be used by clients to determine when objects have changed. May be used |
| 373 | # for optimistic concurrency, change detection, and the watch operation on a |
| 374 | # resource or set of resources. Clients must treat these values as opaque and |
| 375 | # passed unmodified back to the server. They may only be valid for a |
| 376 | # particular resource or set of resources. |
| 377 | # |
| 378 | # Populated by the system. |
| 379 | # Read-only. |
| 380 | # Value must be treated as opaque by clients and . |
| 381 | # More info: |
| 382 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 383 | # +optional |
| 384 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 385 | # Populated by the system. |
| 386 | # Read-only. |
| 387 | # +optional |
| 388 | # string selfLink = 4; |
| 389 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 390 | # generated by the server on successful creation of a resource and is not |
| 391 | # allowed to change on PUT operations. |
| 392 | # |
| 393 | # Populated by the system. |
| 394 | # Read-only. |
| 395 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 396 | # +optional |
| 397 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 398 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 399 | # project ID or project number. |
| 400 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 401 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 402 | # are not queryable and should be preserved when modifying objects. More |
| 403 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 404 | "a_key": "A String", |
| 405 | }, |
| 406 | }, |
| 407 | } |
| 408 | |
| 409 | x__xgafv: string, V1 error format. |
| 410 | Allowed values |
| 411 | 1 - v1 error format |
| 412 | 2 - v2 error format |
| 413 | |
| 414 | Returns: |
| 415 | An object of the form: |
| 416 | |
| 417 | { # The CloudSchedulerSource resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 418 | "status": { # CloudSchedulerSourceStatus represents the current state of a # Status represents the current state of the CloudSchedulerSource. This data |
| 419 | # may be out of date. |
| 420 | # CloudSchedulerSource. |
| 421 | "conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current |
| 422 | # state of the CloudSchedulerSource. |
| 423 | { # Condition defines a generic condition for a Resource |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 424 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 425 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 426 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 427 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 428 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 429 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 430 | # See also: |
| 431 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 432 | # Types common to all resources include: |
| 433 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 434 | }, |
| 435 | ], |
| 436 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudSchedulerSource that |
| 437 | # was last processed by the controller. |
| 438 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 439 | # Source. |
| 440 | }, |
| 441 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 442 | "spec": { # The desired state of the CloudSchedulerSource. # Spec defines the desired state of the CloudSchedulerSource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 443 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 444 | # modifications of the event sent to the sink. |
| 445 | # format of the CloudEvents produced by the Source. |
| 446 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 447 | # event. Each `Extensions` key-value pair are set on the event as an |
| 448 | # attribute extension independently. |
| 449 | # +optional |
| 450 | "a_key": "A String", |
| 451 | }, |
| 452 | }, |
| 453 | "schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run |
| 454 | # every minute. |
| 455 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 456 | # If not specified, defaults to: |
| 457 | # Name: google-cloud-key |
| 458 | # Key: key.json |
| 459 | # |
| 460 | # Cloud Run on GKE: supported |
| 461 | # |
| 462 | # SecretKeySelector selects a key of a Secret. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 463 | "optional": True or False, # Cloud Run fully managed: not supported |
| 464 | # |
| 465 | # Cloud Run on GKE: supported |
| 466 | # |
| 467 | # Specify whether the Secret or its key must be defined |
| 468 | # +optional |
| 469 | "key": "A String", # Cloud Run fully managed: not supported |
| 470 | # |
| 471 | # Cloud Run on GKE: supported |
| 472 | # |
| 473 | # The key of the secret to select from. Must be a valid secret key. |
| 474 | "name": "A String", # Cloud Run fully managed: not supported |
| 475 | # |
| 476 | # Cloud Run on GKE: supported |
| 477 | # |
| 478 | # The name of the secret in the pod's namespace to select from. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 479 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 480 | # directly into the message. Use the "name" field instead. |
| 481 | # referenced object inside the same namespace. |
| 482 | "name": "A String", # Name of the referent. |
| 483 | # More info: |
| 484 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 485 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | }, |
| 487 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 488 | # Topic exists in. If omitted, defaults to same as the cluster. |
| 489 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 490 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 491 | # |
| 492 | # Cloud Run on GKE: supported |
| 493 | # |
| 494 | # SecretKeySelector selects a key of a Secret. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 495 | "optional": True or False, # Cloud Run fully managed: not supported |
| 496 | # |
| 497 | # Cloud Run on GKE: supported |
| 498 | # |
| 499 | # Specify whether the Secret or its key must be defined |
| 500 | # +optional |
| 501 | "key": "A String", # Cloud Run fully managed: not supported |
| 502 | # |
| 503 | # Cloud Run on GKE: supported |
| 504 | # |
| 505 | # The key of the secret to select from. Must be a valid secret key. |
| 506 | "name": "A String", # Cloud Run fully managed: not supported |
| 507 | # |
| 508 | # Cloud Run on GKE: supported |
| 509 | # |
| 510 | # The name of the secret in the pod's namespace to select from. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 511 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 512 | # directly into the message. Use the "name" field instead. |
| 513 | # referenced object inside the same namespace. |
| 514 | "name": "A String", # Name of the referent. |
| 515 | # More info: |
| 516 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 517 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 518 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 519 | "location": "A String", # Location to create the Scheduler job in. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 520 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 521 | # URI directly to use as the sink. |
| 522 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 523 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 524 | # appended to the path of the resulting URL from the Addressable. |
| 525 | # + optional |
| 526 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 527 | # + optional |
| 528 | # referred object. |
| 529 | "apiVersion": "A String", # API version of the referent. |
| 530 | # +optional |
| 531 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 532 | # More info: |
| 533 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 534 | # +optional |
| 535 | "name": "A String", # Name of the referent. |
| 536 | # More info: |
| 537 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 538 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 539 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 540 | # string should contain a valid JSON/Go field access statement, such as |
| 541 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 542 | # is to a container within a pod, this would take on a value like: |
| 543 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 544 | # that triggered the event) or if no container name is specified |
| 545 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 546 | # chosen only to have some well-defined way of referencing a part of an |
| 547 | # object. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 548 | "uid": "A String", # UID of the referent. |
| 549 | # More info: |
| 550 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 551 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 552 | "namespace": "A String", # Namespace of the referent. |
| 553 | # More info: |
| 554 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 555 | # +optional |
| 556 | "kind": "A String", # Kind of the referent. |
| 557 | # More info: |
| 558 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 559 | # +optional |
| 560 | }, |
| 561 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 562 | "data": "A String", # Data to send in the payload of the Event. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 563 | }, |
| 564 | "kind": "A String", # The kind of resource, in this case "CloudSchedulerSource". |
| 565 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudSchedulerSource. |
| 566 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 567 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 568 | # |
| 569 | # GenerateName is an optional prefix, used by the server, to generate a |
| 570 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 571 | # used, the name returned to the client will be different than the name |
| 572 | # passed. This value will also be combined with a unique suffix. The provided |
| 573 | # value has the same validation rules as the Name field, and may be truncated |
| 574 | # by the length of the suffix required to make the value unique on the |
| 575 | # server. |
| 576 | # |
| 577 | # If this field is specified and the generated name exists, the server will |
| 578 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 579 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 580 | # time allotted, and the client should retry (optionally after the time |
| 581 | # indicated in the Retry-After header). |
| 582 | # |
| 583 | # Applied only if Name is not specified. |
| 584 | # More info: |
| 585 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 586 | # +optional |
| 587 | # string generateName = 2; |
| 588 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 589 | # Is required when creating |
| 590 | # resources, although some resources may allow a client to request the |
| 591 | # generation of an appropriate name automatically. Name is primarily intended |
| 592 | # for creation idempotence and configuration definition. Cannot be updated. |
| 593 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 594 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 595 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 596 | # |
| 597 | # Number of seconds allowed for this object to gracefully terminate before |
| 598 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 599 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 600 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 601 | # |
| 602 | # The name of the cluster which the object belongs to. |
| 603 | # This is used to distinguish resources with same name and namespace in |
| 604 | # different clusters. This field is not set anywhere right now and apiserver |
| 605 | # is going to ignore it if set in create or update request. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 606 | "finalizers": [ # Not currently supported by Cloud Run. |
| 607 | # |
| 608 | # Must be empty before the object is deleted from the registry. Each entry |
| 609 | # is an identifier for the responsible component that will remove the entry |
| 610 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 611 | # in this list can only be removed. |
| 612 | # +optional |
| 613 | # +patchStrategy=merge |
| 614 | "A String", |
| 615 | ], |
| 616 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 617 | # deleted. This field is set by the server when a graceful deletion is |
| 618 | # requested by the user, and is not directly settable by a client. The |
| 619 | # resource is expected to be deleted (no longer visible from resource lists, |
| 620 | # and not reachable by name) after the time in this field, once the |
| 621 | # finalizers list is empty. As long as the finalizers list contains items, |
| 622 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 623 | # be unset or be set further into the future, although it may be shortened or |
| 624 | # the resource may be deleted prior to this time. For example, a user may |
| 625 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 626 | # sending a graceful termination signal to the containers in the pod. After |
| 627 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 628 | # to the container and after cleanup, remove the pod from the API. In the |
| 629 | # presence of network partitions, this object may still exist after this |
| 630 | # timestamp, until an administrator or automated process can determine the |
| 631 | # resource is fully terminated. |
| 632 | # If not set, graceful deletion of the object has not been requested. |
| 633 | # |
| 634 | # Populated by the system when a graceful deletion is requested. |
| 635 | # Read-only. |
| 636 | # More info: |
| 637 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 638 | # +optional |
| 639 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 640 | # been deleted, this object will be garbage collected. |
| 641 | # +optional |
| 642 | { # OwnerReference contains enough information to let you identify an owning |
| 643 | # object. Currently, an owning object must be in the same namespace, so there |
| 644 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 645 | "controller": True or False, # If true, this reference points to the managing controller. |
| 646 | # +optional |
| 647 | "kind": "A String", # Kind of the referent. |
| 648 | # More info: |
| 649 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 650 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 651 | # the owner cannot be deleted from the key-value store until this |
| 652 | # reference is removed. |
| 653 | # Defaults to false. |
| 654 | # To set this field, a user needs "delete" permission of the owner, |
| 655 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 656 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 657 | "apiVersion": "A String", # API version of the referent. |
| 658 | "name": "A String", # Name of the referent. |
| 659 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 660 | "uid": "A String", # UID of the referent. |
| 661 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 662 | }, |
| 663 | ], |
| 664 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 665 | # object was created. It is not guaranteed to be set in happens-before order |
| 666 | # across separate operations. Clients may not set this value. It is |
| 667 | # represented in RFC3339 form and is in UTC. |
| 668 | # |
| 669 | # Populated by the system. |
| 670 | # Read-only. |
| 671 | # Null for lists. |
| 672 | # More info: |
| 673 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 674 | # +optional |
| 675 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 676 | # (scope and select) objects. May match selectors of replication controllers |
| 677 | # and routes. |
| 678 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 679 | # +optional |
| 680 | "a_key": "A String", |
| 681 | }, |
| 682 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 683 | # Populated by the system. Read-only. |
| 684 | # +optional |
| 685 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 686 | # can be used by clients to determine when objects have changed. May be used |
| 687 | # for optimistic concurrency, change detection, and the watch operation on a |
| 688 | # resource or set of resources. Clients must treat these values as opaque and |
| 689 | # passed unmodified back to the server. They may only be valid for a |
| 690 | # particular resource or set of resources. |
| 691 | # |
| 692 | # Populated by the system. |
| 693 | # Read-only. |
| 694 | # Value must be treated as opaque by clients and . |
| 695 | # More info: |
| 696 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 697 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 698 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 699 | # Populated by the system. |
| 700 | # Read-only. |
| 701 | # +optional |
| 702 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 703 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 704 | # generated by the server on successful creation of a resource and is not |
| 705 | # allowed to change on PUT operations. |
| 706 | # |
| 707 | # Populated by the system. |
| 708 | # Read-only. |
| 709 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 710 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 711 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 712 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 713 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 714 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 715 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 716 | # are not queryable and should be preserved when modifying objects. More |
| 717 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 718 | "a_key": "A String", |
| 719 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 720 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 721 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 722 | </div> |
| 723 | |
| 724 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 725 | <code class="details" id="delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 726 | <pre>Rpc to delete a cloudschedulersource. |
| 727 | |
| 728 | Args: |
| 729 | name: string, Required. The name of the cloudschedulersource being deleted. If needed, replace |
| 730 | {namespace_id} with the project ID. (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 731 | apiVersion: string, Cloud Run currently ignores this parameter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 732 | propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores |
| 733 | this setting, and deletes in the background. Please see |
| 734 | kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for |
| 735 | more information. |
| 736 | kind: string, Cloud Run currently ignores this parameter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 737 | x__xgafv: string, V1 error format. |
| 738 | Allowed values |
| 739 | 1 - v1 error format |
| 740 | 2 - v2 error format |
| 741 | |
| 742 | Returns: |
| 743 | An object of the form: |
| 744 | |
| 745 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 746 | # empty messages in your APIs. A typical example is to use it as the request |
| 747 | # or the response type of an API method. For instance: |
| 748 | # |
| 749 | # service Foo { |
| 750 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 751 | # } |
| 752 | # |
| 753 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 754 | }</pre> |
| 755 | </div> |
| 756 | |
| 757 | <div class="method"> |
| 758 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 759 | <pre>Rpc to get information about a cloudschedulersource. |
| 760 | |
| 761 | Args: |
| 762 | name: string, Required. The name of the cloudschedulersource being retrieved. If needed, replace |
| 763 | {namespace_id} with the project ID. (required) |
| 764 | x__xgafv: string, V1 error format. |
| 765 | Allowed values |
| 766 | 1 - v1 error format |
| 767 | 2 - v2 error format |
| 768 | |
| 769 | Returns: |
| 770 | An object of the form: |
| 771 | |
| 772 | { # The CloudSchedulerSource resource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 773 | "status": { # CloudSchedulerSourceStatus represents the current state of a # Status represents the current state of the CloudSchedulerSource. This data |
| 774 | # may be out of date. |
| 775 | # CloudSchedulerSource. |
| 776 | "conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current |
| 777 | # state of the CloudSchedulerSource. |
| 778 | { # Condition defines a generic condition for a Resource |
| 779 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 780 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 781 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 782 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 783 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 784 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 785 | # See also: |
| 786 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 787 | # Types common to all resources include: |
| 788 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 789 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 790 | ], |
| 791 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudSchedulerSource that |
| 792 | # was last processed by the controller. |
| 793 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 794 | # Source. |
| 795 | }, |
| 796 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 797 | "spec": { # The desired state of the CloudSchedulerSource. # Spec defines the desired state of the CloudSchedulerSource. |
| 798 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 799 | # modifications of the event sent to the sink. |
| 800 | # format of the CloudEvents produced by the Source. |
| 801 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 802 | # event. Each `Extensions` key-value pair are set on the event as an |
| 803 | # attribute extension independently. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 804 | # +optional |
| 805 | "a_key": "A String", |
| 806 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 807 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 808 | "schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run |
| 809 | # every minute. |
| 810 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 811 | # If not specified, defaults to: |
| 812 | # Name: google-cloud-key |
| 813 | # Key: key.json |
| 814 | # |
| 815 | # Cloud Run on GKE: supported |
| 816 | # |
| 817 | # SecretKeySelector selects a key of a Secret. |
| 818 | "optional": True or False, # Cloud Run fully managed: not supported |
| 819 | # |
| 820 | # Cloud Run on GKE: supported |
| 821 | # |
| 822 | # Specify whether the Secret or its key must be defined |
| 823 | # +optional |
| 824 | "key": "A String", # Cloud Run fully managed: not supported |
| 825 | # |
| 826 | # Cloud Run on GKE: supported |
| 827 | # |
| 828 | # The key of the secret to select from. Must be a valid secret key. |
| 829 | "name": "A String", # Cloud Run fully managed: not supported |
| 830 | # |
| 831 | # Cloud Run on GKE: supported |
| 832 | # |
| 833 | # The name of the secret in the pod's namespace to select from. |
| 834 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 835 | # directly into the message. Use the "name" field instead. |
| 836 | # referenced object inside the same namespace. |
| 837 | "name": "A String", # Name of the referent. |
| 838 | # More info: |
| 839 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 840 | }, |
| 841 | }, |
| 842 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 843 | # Topic exists in. If omitted, defaults to same as the cluster. |
| 844 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 845 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 846 | # |
| 847 | # Cloud Run on GKE: supported |
| 848 | # |
| 849 | # SecretKeySelector selects a key of a Secret. |
| 850 | "optional": True or False, # Cloud Run fully managed: not supported |
| 851 | # |
| 852 | # Cloud Run on GKE: supported |
| 853 | # |
| 854 | # Specify whether the Secret or its key must be defined |
| 855 | # +optional |
| 856 | "key": "A String", # Cloud Run fully managed: not supported |
| 857 | # |
| 858 | # Cloud Run on GKE: supported |
| 859 | # |
| 860 | # The key of the secret to select from. Must be a valid secret key. |
| 861 | "name": "A String", # Cloud Run fully managed: not supported |
| 862 | # |
| 863 | # Cloud Run on GKE: supported |
| 864 | # |
| 865 | # The name of the secret in the pod's namespace to select from. |
| 866 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 867 | # directly into the message. Use the "name" field instead. |
| 868 | # referenced object inside the same namespace. |
| 869 | "name": "A String", # Name of the referent. |
| 870 | # More info: |
| 871 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 872 | }, |
| 873 | }, |
| 874 | "location": "A String", # Location to create the Scheduler job in. |
| 875 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 876 | # URI directly to use as the sink. |
| 877 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 878 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 879 | # appended to the path of the resulting URL from the Addressable. |
| 880 | # + optional |
| 881 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 882 | # + optional |
| 883 | # referred object. |
| 884 | "apiVersion": "A String", # API version of the referent. |
| 885 | # +optional |
| 886 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 887 | # More info: |
| 888 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 889 | # +optional |
| 890 | "name": "A String", # Name of the referent. |
| 891 | # More info: |
| 892 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 893 | # +optional |
| 894 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 895 | # string should contain a valid JSON/Go field access statement, such as |
| 896 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 897 | # is to a container within a pod, this would take on a value like: |
| 898 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 899 | # that triggered the event) or if no container name is specified |
| 900 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 901 | # chosen only to have some well-defined way of referencing a part of an |
| 902 | # object. |
| 903 | "uid": "A String", # UID of the referent. |
| 904 | # More info: |
| 905 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 906 | # +optional |
| 907 | "namespace": "A String", # Namespace of the referent. |
| 908 | # More info: |
| 909 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 910 | # +optional |
| 911 | "kind": "A String", # Kind of the referent. |
| 912 | # More info: |
| 913 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 914 | # +optional |
| 915 | }, |
| 916 | }, |
| 917 | "data": "A String", # Data to send in the payload of the Event. |
| 918 | }, |
| 919 | "kind": "A String", # The kind of resource, in this case "CloudSchedulerSource". |
| 920 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudSchedulerSource. |
| 921 | # all objects users must create. |
| 922 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 923 | # |
| 924 | # GenerateName is an optional prefix, used by the server, to generate a |
| 925 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 926 | # used, the name returned to the client will be different than the name |
| 927 | # passed. This value will also be combined with a unique suffix. The provided |
| 928 | # value has the same validation rules as the Name field, and may be truncated |
| 929 | # by the length of the suffix required to make the value unique on the |
| 930 | # server. |
| 931 | # |
| 932 | # If this field is specified and the generated name exists, the server will |
| 933 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 934 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 935 | # time allotted, and the client should retry (optionally after the time |
| 936 | # indicated in the Retry-After header). |
| 937 | # |
| 938 | # Applied only if Name is not specified. |
| 939 | # More info: |
| 940 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 941 | # +optional |
| 942 | # string generateName = 2; |
| 943 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 944 | # Is required when creating |
| 945 | # resources, although some resources may allow a client to request the |
| 946 | # generation of an appropriate name automatically. Name is primarily intended |
| 947 | # for creation idempotence and configuration definition. Cannot be updated. |
| 948 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 949 | # +optional |
| 950 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 951 | # |
| 952 | # Number of seconds allowed for this object to gracefully terminate before |
| 953 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 954 | # set. May only be shortened. Read-only. +optional |
| 955 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 956 | # |
| 957 | # The name of the cluster which the object belongs to. |
| 958 | # This is used to distinguish resources with same name and namespace in |
| 959 | # different clusters. This field is not set anywhere right now and apiserver |
| 960 | # is going to ignore it if set in create or update request. +optional |
| 961 | "finalizers": [ # Not currently supported by Cloud Run. |
| 962 | # |
| 963 | # Must be empty before the object is deleted from the registry. Each entry |
| 964 | # is an identifier for the responsible component that will remove the entry |
| 965 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 966 | # in this list can only be removed. |
| 967 | # +optional |
| 968 | # +patchStrategy=merge |
| 969 | "A String", |
| 970 | ], |
| 971 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 972 | # deleted. This field is set by the server when a graceful deletion is |
| 973 | # requested by the user, and is not directly settable by a client. The |
| 974 | # resource is expected to be deleted (no longer visible from resource lists, |
| 975 | # and not reachable by name) after the time in this field, once the |
| 976 | # finalizers list is empty. As long as the finalizers list contains items, |
| 977 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 978 | # be unset or be set further into the future, although it may be shortened or |
| 979 | # the resource may be deleted prior to this time. For example, a user may |
| 980 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 981 | # sending a graceful termination signal to the containers in the pod. After |
| 982 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 983 | # to the container and after cleanup, remove the pod from the API. In the |
| 984 | # presence of network partitions, this object may still exist after this |
| 985 | # timestamp, until an administrator or automated process can determine the |
| 986 | # resource is fully terminated. |
| 987 | # If not set, graceful deletion of the object has not been requested. |
| 988 | # |
| 989 | # Populated by the system when a graceful deletion is requested. |
| 990 | # Read-only. |
| 991 | # More info: |
| 992 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 993 | # +optional |
| 994 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 995 | # been deleted, this object will be garbage collected. |
| 996 | # +optional |
| 997 | { # OwnerReference contains enough information to let you identify an owning |
| 998 | # object. Currently, an owning object must be in the same namespace, so there |
| 999 | # is no namespace field. |
| 1000 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1001 | # +optional |
| 1002 | "kind": "A String", # Kind of the referent. |
| 1003 | # More info: |
| 1004 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1005 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1006 | # the owner cannot be deleted from the key-value store until this |
| 1007 | # reference is removed. |
| 1008 | # Defaults to false. |
| 1009 | # To set this field, a user needs "delete" permission of the owner, |
| 1010 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1011 | # +optional |
| 1012 | "apiVersion": "A String", # API version of the referent. |
| 1013 | "name": "A String", # Name of the referent. |
| 1014 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1015 | "uid": "A String", # UID of the referent. |
| 1016 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1017 | }, |
| 1018 | ], |
| 1019 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 1020 | # object was created. It is not guaranteed to be set in happens-before order |
| 1021 | # across separate operations. Clients may not set this value. It is |
| 1022 | # represented in RFC3339 form and is in UTC. |
| 1023 | # |
| 1024 | # Populated by the system. |
| 1025 | # Read-only. |
| 1026 | # Null for lists. |
| 1027 | # More info: |
| 1028 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1029 | # +optional |
| 1030 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 1031 | # (scope and select) objects. May match selectors of replication controllers |
| 1032 | # and routes. |
| 1033 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1034 | # +optional |
| 1035 | "a_key": "A String", |
| 1036 | }, |
| 1037 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 1038 | # Populated by the system. Read-only. |
| 1039 | # +optional |
| 1040 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 1041 | # can be used by clients to determine when objects have changed. May be used |
| 1042 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1043 | # resource or set of resources. Clients must treat these values as opaque and |
| 1044 | # passed unmodified back to the server. They may only be valid for a |
| 1045 | # particular resource or set of resources. |
| 1046 | # |
| 1047 | # Populated by the system. |
| 1048 | # Read-only. |
| 1049 | # Value must be treated as opaque by clients and . |
| 1050 | # More info: |
| 1051 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1052 | # +optional |
| 1053 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 1054 | # Populated by the system. |
| 1055 | # Read-only. |
| 1056 | # +optional |
| 1057 | # string selfLink = 4; |
| 1058 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 1059 | # generated by the server on successful creation of a resource and is not |
| 1060 | # allowed to change on PUT operations. |
| 1061 | # |
| 1062 | # Populated by the system. |
| 1063 | # Read-only. |
| 1064 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1065 | # +optional |
| 1066 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1067 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1068 | # project ID or project number. |
| 1069 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 1070 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1071 | # are not queryable and should be preserved when modifying objects. More |
| 1072 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 1073 | "a_key": "A String", |
| 1074 | }, |
| 1075 | }, |
| 1076 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1077 | </div> |
| 1078 | |
| 1079 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1080 | <code class="details" id="list">list(parent, watch=None, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, continue=None, limit=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1081 | <pre>Rpc to list cloudschedulersources. |
| 1082 | |
| 1083 | Args: |
| 1084 | parent: string, Required. The project ID or project number from which the cloudschedulersources |
| 1085 | should be listed. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1086 | watch: boolean, Flag that indicates that the client expects to watch this resource as well. |
| 1087 | Not currently used by Cloud Run. |
| 1088 | labelSelector: string, Allows to filter resources based on a label. Supported operations are |
| 1089 | =, !=, exists, in, and notIn. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1090 | fieldSelector: string, Allows to filter resources based on a specific value for a field name. |
| 1091 | Send this in a query string format. i.e. 'metadata.name%3Dlorem'. |
| 1092 | Not currently used by Cloud Run. |
| 1093 | includeUninitialized: boolean, Not currently used by Cloud Run. |
| 1094 | resourceVersion: string, The baseline resource version from which the list or watch operation should |
| 1095 | start. Not currently used by Cloud Run. |
| 1096 | continue: string, Optional encoded string to continue paging. |
| 1097 | limit: integer, The maximum number of records that should be returned. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1098 | x__xgafv: string, V1 error format. |
| 1099 | Allowed values |
| 1100 | 1 - v1 error format |
| 1101 | 2 - v2 error format |
| 1102 | |
| 1103 | Returns: |
| 1104 | An object of the form: |
| 1105 | |
| 1106 | { # ListCloudSchedulerSourcesResponse is a list of CloudSchedulerSource |
| 1107 | # resources. |
| 1108 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 1109 | "kind": "A String", # The kind of this resource, in this case "CloudSchedulerSourceList". |
| 1110 | "unreachable": [ # Locations that could not be reached. |
| 1111 | "A String", |
| 1112 | ], |
| 1113 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this CloudSchedulerSource list. |
| 1114 | # lists and various status objects. A resource may have only one of |
| 1115 | # {ObjectMeta, ListMeta}. |
| 1116 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| 1117 | # can be used by clients to determine when objects have changed. Value must |
| 1118 | # be treated as opaque by clients and passed unmodified back to the server. |
| 1119 | # Populated by the system. |
| 1120 | # Read-only. |
| 1121 | # More info: |
| 1122 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1123 | # +optional |
| 1124 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 1125 | # returned, and indicates that the server has more data available. The value |
| 1126 | # is opaque and may be used to issue another request to the endpoint that |
| 1127 | # served this list to retrieve the next set of available objects. Continuing |
| 1128 | # a list may not be possible if the server configuration has changed or more |
| 1129 | # than a few minutes have passed. The resourceVersion field returned when |
| 1130 | # using this continue value will be identical to the value in the first |
| 1131 | # response. |
| 1132 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 1133 | # Populated by the system. |
| 1134 | # Read-only. |
| 1135 | # +optional |
| 1136 | }, |
| 1137 | "items": [ # List of CloudSchedulerSources. |
| 1138 | { # The CloudSchedulerSource resource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1139 | "status": { # CloudSchedulerSourceStatus represents the current state of a # Status represents the current state of the CloudSchedulerSource. This data |
| 1140 | # may be out of date. |
| 1141 | # CloudSchedulerSource. |
| 1142 | "conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current |
| 1143 | # state of the CloudSchedulerSource. |
| 1144 | { # Condition defines a generic condition for a Resource |
| 1145 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 1146 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 1147 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 1148 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 1149 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 1150 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 1151 | # See also: |
| 1152 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 1153 | # Types common to all resources include: |
| 1154 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1155 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1156 | ], |
| 1157 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudSchedulerSource that |
| 1158 | # was last processed by the controller. |
| 1159 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 1160 | # Source. |
| 1161 | }, |
| 1162 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 1163 | "spec": { # The desired state of the CloudSchedulerSource. # Spec defines the desired state of the CloudSchedulerSource. |
| 1164 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 1165 | # modifications of the event sent to the sink. |
| 1166 | # format of the CloudEvents produced by the Source. |
| 1167 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 1168 | # event. Each `Extensions` key-value pair are set on the event as an |
| 1169 | # attribute extension independently. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1170 | # +optional |
| 1171 | "a_key": "A String", |
| 1172 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1173 | }, |
| 1174 | "schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run |
| 1175 | # every minute. |
| 1176 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 1177 | # If not specified, defaults to: |
| 1178 | # Name: google-cloud-key |
| 1179 | # Key: key.json |
| 1180 | # |
| 1181 | # Cloud Run on GKE: supported |
| 1182 | # |
| 1183 | # SecretKeySelector selects a key of a Secret. |
| 1184 | "optional": True or False, # Cloud Run fully managed: not supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1185 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1186 | # Cloud Run on GKE: supported |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1187 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1188 | # Specify whether the Secret or its key must be defined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1189 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1190 | "key": "A String", # Cloud Run fully managed: not supported |
| 1191 | # |
| 1192 | # Cloud Run on GKE: supported |
| 1193 | # |
| 1194 | # The key of the secret to select from. Must be a valid secret key. |
| 1195 | "name": "A String", # Cloud Run fully managed: not supported |
| 1196 | # |
| 1197 | # Cloud Run on GKE: supported |
| 1198 | # |
| 1199 | # The name of the secret in the pod's namespace to select from. |
| 1200 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 1201 | # directly into the message. Use the "name" field instead. |
| 1202 | # referenced object inside the same namespace. |
| 1203 | "name": "A String", # Name of the referent. |
| 1204 | # More info: |
| 1205 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1206 | }, |
| 1207 | }, |
| 1208 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 1209 | # Topic exists in. If omitted, defaults to same as the cluster. |
| 1210 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 1211 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 1212 | # |
| 1213 | # Cloud Run on GKE: supported |
| 1214 | # |
| 1215 | # SecretKeySelector selects a key of a Secret. |
| 1216 | "optional": True or False, # Cloud Run fully managed: not supported |
| 1217 | # |
| 1218 | # Cloud Run on GKE: supported |
| 1219 | # |
| 1220 | # Specify whether the Secret or its key must be defined |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1221 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1222 | "key": "A String", # Cloud Run fully managed: not supported |
| 1223 | # |
| 1224 | # Cloud Run on GKE: supported |
| 1225 | # |
| 1226 | # The key of the secret to select from. Must be a valid secret key. |
| 1227 | "name": "A String", # Cloud Run fully managed: not supported |
| 1228 | # |
| 1229 | # Cloud Run on GKE: supported |
| 1230 | # |
| 1231 | # The name of the secret in the pod's namespace to select from. |
| 1232 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 1233 | # directly into the message. Use the "name" field instead. |
| 1234 | # referenced object inside the same namespace. |
| 1235 | "name": "A String", # Name of the referent. |
| 1236 | # More info: |
| 1237 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1238 | }, |
| 1239 | }, |
| 1240 | "location": "A String", # Location to create the Scheduler job in. |
| 1241 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 1242 | # URI directly to use as the sink. |
| 1243 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 1244 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 1245 | # appended to the path of the resulting URL from the Addressable. |
| 1246 | # + optional |
| 1247 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 1248 | # + optional |
| 1249 | # referred object. |
| 1250 | "apiVersion": "A String", # API version of the referent. |
| 1251 | # +optional |
| 1252 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 1253 | # More info: |
| 1254 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1255 | # +optional |
| 1256 | "name": "A String", # Name of the referent. |
| 1257 | # More info: |
| 1258 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1259 | # +optional |
| 1260 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 1261 | # string should contain a valid JSON/Go field access statement, such as |
| 1262 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 1263 | # is to a container within a pod, this would take on a value like: |
| 1264 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 1265 | # that triggered the event) or if no container name is specified |
| 1266 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 1267 | # chosen only to have some well-defined way of referencing a part of an |
| 1268 | # object. |
| 1269 | "uid": "A String", # UID of the referent. |
| 1270 | # More info: |
| 1271 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 1272 | # +optional |
| 1273 | "namespace": "A String", # Namespace of the referent. |
| 1274 | # More info: |
| 1275 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 1276 | # +optional |
| 1277 | "kind": "A String", # Kind of the referent. |
| 1278 | # More info: |
| 1279 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1280 | # +optional |
| 1281 | }, |
| 1282 | }, |
| 1283 | "data": "A String", # Data to send in the payload of the Event. |
| 1284 | }, |
| 1285 | "kind": "A String", # The kind of resource, in this case "CloudSchedulerSource". |
| 1286 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudSchedulerSource. |
| 1287 | # all objects users must create. |
| 1288 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 1289 | # |
| 1290 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1291 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1292 | # used, the name returned to the client will be different than the name |
| 1293 | # passed. This value will also be combined with a unique suffix. The provided |
| 1294 | # value has the same validation rules as the Name field, and may be truncated |
| 1295 | # by the length of the suffix required to make the value unique on the |
| 1296 | # server. |
| 1297 | # |
| 1298 | # If this field is specified and the generated name exists, the server will |
| 1299 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1300 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1301 | # time allotted, and the client should retry (optionally after the time |
| 1302 | # indicated in the Retry-After header). |
| 1303 | # |
| 1304 | # Applied only if Name is not specified. |
| 1305 | # More info: |
| 1306 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1307 | # +optional |
| 1308 | # string generateName = 2; |
| 1309 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1310 | # Is required when creating |
| 1311 | # resources, although some resources may allow a client to request the |
| 1312 | # generation of an appropriate name automatically. Name is primarily intended |
| 1313 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1314 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1315 | # +optional |
| 1316 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 1317 | # |
| 1318 | # Number of seconds allowed for this object to gracefully terminate before |
| 1319 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1320 | # set. May only be shortened. Read-only. +optional |
| 1321 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 1322 | # |
| 1323 | # The name of the cluster which the object belongs to. |
| 1324 | # This is used to distinguish resources with same name and namespace in |
| 1325 | # different clusters. This field is not set anywhere right now and apiserver |
| 1326 | # is going to ignore it if set in create or update request. +optional |
| 1327 | "finalizers": [ # Not currently supported by Cloud Run. |
| 1328 | # |
| 1329 | # Must be empty before the object is deleted from the registry. Each entry |
| 1330 | # is an identifier for the responsible component that will remove the entry |
| 1331 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1332 | # in this list can only be removed. |
| 1333 | # +optional |
| 1334 | # +patchStrategy=merge |
| 1335 | "A String", |
| 1336 | ], |
| 1337 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1338 | # deleted. This field is set by the server when a graceful deletion is |
| 1339 | # requested by the user, and is not directly settable by a client. The |
| 1340 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1341 | # and not reachable by name) after the time in this field, once the |
| 1342 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1343 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1344 | # be unset or be set further into the future, although it may be shortened or |
| 1345 | # the resource may be deleted prior to this time. For example, a user may |
| 1346 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1347 | # sending a graceful termination signal to the containers in the pod. After |
| 1348 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1349 | # to the container and after cleanup, remove the pod from the API. In the |
| 1350 | # presence of network partitions, this object may still exist after this |
| 1351 | # timestamp, until an administrator or automated process can determine the |
| 1352 | # resource is fully terminated. |
| 1353 | # If not set, graceful deletion of the object has not been requested. |
| 1354 | # |
| 1355 | # Populated by the system when a graceful deletion is requested. |
| 1356 | # Read-only. |
| 1357 | # More info: |
| 1358 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1359 | # +optional |
| 1360 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 1361 | # been deleted, this object will be garbage collected. |
| 1362 | # +optional |
| 1363 | { # OwnerReference contains enough information to let you identify an owning |
| 1364 | # object. Currently, an owning object must be in the same namespace, so there |
| 1365 | # is no namespace field. |
| 1366 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1367 | # +optional |
| 1368 | "kind": "A String", # Kind of the referent. |
| 1369 | # More info: |
| 1370 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1371 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1372 | # the owner cannot be deleted from the key-value store until this |
| 1373 | # reference is removed. |
| 1374 | # Defaults to false. |
| 1375 | # To set this field, a user needs "delete" permission of the owner, |
| 1376 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1377 | # +optional |
| 1378 | "apiVersion": "A String", # API version of the referent. |
| 1379 | "name": "A String", # Name of the referent. |
| 1380 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1381 | "uid": "A String", # UID of the referent. |
| 1382 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1383 | }, |
| 1384 | ], |
| 1385 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 1386 | # object was created. It is not guaranteed to be set in happens-before order |
| 1387 | # across separate operations. Clients may not set this value. It is |
| 1388 | # represented in RFC3339 form and is in UTC. |
| 1389 | # |
| 1390 | # Populated by the system. |
| 1391 | # Read-only. |
| 1392 | # Null for lists. |
| 1393 | # More info: |
| 1394 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1395 | # +optional |
| 1396 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 1397 | # (scope and select) objects. May match selectors of replication controllers |
| 1398 | # and routes. |
| 1399 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1400 | # +optional |
| 1401 | "a_key": "A String", |
| 1402 | }, |
| 1403 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 1404 | # Populated by the system. Read-only. |
| 1405 | # +optional |
| 1406 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 1407 | # can be used by clients to determine when objects have changed. May be used |
| 1408 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1409 | # resource or set of resources. Clients must treat these values as opaque and |
| 1410 | # passed unmodified back to the server. They may only be valid for a |
| 1411 | # particular resource or set of resources. |
| 1412 | # |
| 1413 | # Populated by the system. |
| 1414 | # Read-only. |
| 1415 | # Value must be treated as opaque by clients and . |
| 1416 | # More info: |
| 1417 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1418 | # +optional |
| 1419 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 1420 | # Populated by the system. |
| 1421 | # Read-only. |
| 1422 | # +optional |
| 1423 | # string selfLink = 4; |
| 1424 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 1425 | # generated by the server on successful creation of a resource and is not |
| 1426 | # allowed to change on PUT operations. |
| 1427 | # |
| 1428 | # Populated by the system. |
| 1429 | # Read-only. |
| 1430 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1431 | # +optional |
| 1432 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1433 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1434 | # project ID or project number. |
| 1435 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 1436 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1437 | # are not queryable and should be preserved when modifying objects. More |
| 1438 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 1439 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1440 | }, |
| 1441 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1442 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1443 | ], |
| 1444 | }</pre> |
| 1445 | </div> |
| 1446 | |
| 1447 | <div class="method"> |
| 1448 | <code class="details" id="replaceCloudSchedulerSource">replaceCloudSchedulerSource(name, body=None, x__xgafv=None)</code> |
| 1449 | <pre>Rpc to replace a cloudschedulersource. |
| 1450 | |
| 1451 | Only the spec and metadata labels and annotations are modifiable. After |
| 1452 | the Update request, Cloud Run will work to make the 'status' |
| 1453 | match the requested 'spec'. |
| 1454 | |
| 1455 | May provide metadata.resourceVersion to enforce update from last read for |
| 1456 | optimistic concurrency control. |
| 1457 | |
| 1458 | Args: |
| 1459 | name: string, Required. The name of the cloudschedulersource being retrieved. If needed, replace |
| 1460 | {namespace_id} with the project ID. (required) |
| 1461 | body: object, The request body. |
| 1462 | The object takes the form of: |
| 1463 | |
| 1464 | { # The CloudSchedulerSource resource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1465 | "status": { # CloudSchedulerSourceStatus represents the current state of a # Status represents the current state of the CloudSchedulerSource. This data |
| 1466 | # may be out of date. |
| 1467 | # CloudSchedulerSource. |
| 1468 | "conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current |
| 1469 | # state of the CloudSchedulerSource. |
| 1470 | { # Condition defines a generic condition for a Resource |
| 1471 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 1472 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 1473 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 1474 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 1475 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 1476 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 1477 | # See also: |
| 1478 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 1479 | # Types common to all resources include: |
| 1480 | # * "Ready": True when the Resource is ready. |
| 1481 | }, |
| 1482 | ], |
| 1483 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudSchedulerSource that |
| 1484 | # was last processed by the controller. |
| 1485 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 1486 | # Source. |
| 1487 | }, |
| 1488 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 1489 | "spec": { # The desired state of the CloudSchedulerSource. # Spec defines the desired state of the CloudSchedulerSource. |
| 1490 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 1491 | # modifications of the event sent to the sink. |
| 1492 | # format of the CloudEvents produced by the Source. |
| 1493 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 1494 | # event. Each `Extensions` key-value pair are set on the event as an |
| 1495 | # attribute extension independently. |
| 1496 | # +optional |
| 1497 | "a_key": "A String", |
| 1498 | }, |
| 1499 | }, |
| 1500 | "schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run |
| 1501 | # every minute. |
| 1502 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 1503 | # If not specified, defaults to: |
| 1504 | # Name: google-cloud-key |
| 1505 | # Key: key.json |
| 1506 | # |
| 1507 | # Cloud Run on GKE: supported |
| 1508 | # |
| 1509 | # SecretKeySelector selects a key of a Secret. |
| 1510 | "optional": True or False, # Cloud Run fully managed: not supported |
| 1511 | # |
| 1512 | # Cloud Run on GKE: supported |
| 1513 | # |
| 1514 | # Specify whether the Secret or its key must be defined |
| 1515 | # +optional |
| 1516 | "key": "A String", # Cloud Run fully managed: not supported |
| 1517 | # |
| 1518 | # Cloud Run on GKE: supported |
| 1519 | # |
| 1520 | # The key of the secret to select from. Must be a valid secret key. |
| 1521 | "name": "A String", # Cloud Run fully managed: not supported |
| 1522 | # |
| 1523 | # Cloud Run on GKE: supported |
| 1524 | # |
| 1525 | # The name of the secret in the pod's namespace to select from. |
| 1526 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 1527 | # directly into the message. Use the "name" field instead. |
| 1528 | # referenced object inside the same namespace. |
| 1529 | "name": "A String", # Name of the referent. |
| 1530 | # More info: |
| 1531 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1532 | }, |
| 1533 | }, |
| 1534 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 1535 | # Topic exists in. If omitted, defaults to same as the cluster. |
| 1536 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 1537 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 1538 | # |
| 1539 | # Cloud Run on GKE: supported |
| 1540 | # |
| 1541 | # SecretKeySelector selects a key of a Secret. |
| 1542 | "optional": True or False, # Cloud Run fully managed: not supported |
| 1543 | # |
| 1544 | # Cloud Run on GKE: supported |
| 1545 | # |
| 1546 | # Specify whether the Secret or its key must be defined |
| 1547 | # +optional |
| 1548 | "key": "A String", # Cloud Run fully managed: not supported |
| 1549 | # |
| 1550 | # Cloud Run on GKE: supported |
| 1551 | # |
| 1552 | # The key of the secret to select from. Must be a valid secret key. |
| 1553 | "name": "A String", # Cloud Run fully managed: not supported |
| 1554 | # |
| 1555 | # Cloud Run on GKE: supported |
| 1556 | # |
| 1557 | # The name of the secret in the pod's namespace to select from. |
| 1558 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 1559 | # directly into the message. Use the "name" field instead. |
| 1560 | # referenced object inside the same namespace. |
| 1561 | "name": "A String", # Name of the referent. |
| 1562 | # More info: |
| 1563 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1564 | }, |
| 1565 | }, |
| 1566 | "location": "A String", # Location to create the Scheduler job in. |
| 1567 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 1568 | # URI directly to use as the sink. |
| 1569 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 1570 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 1571 | # appended to the path of the resulting URL from the Addressable. |
| 1572 | # + optional |
| 1573 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 1574 | # + optional |
| 1575 | # referred object. |
| 1576 | "apiVersion": "A String", # API version of the referent. |
| 1577 | # +optional |
| 1578 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 1579 | # More info: |
| 1580 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1581 | # +optional |
| 1582 | "name": "A String", # Name of the referent. |
| 1583 | # More info: |
| 1584 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1585 | # +optional |
| 1586 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 1587 | # string should contain a valid JSON/Go field access statement, such as |
| 1588 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 1589 | # is to a container within a pod, this would take on a value like: |
| 1590 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 1591 | # that triggered the event) or if no container name is specified |
| 1592 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 1593 | # chosen only to have some well-defined way of referencing a part of an |
| 1594 | # object. |
| 1595 | "uid": "A String", # UID of the referent. |
| 1596 | # More info: |
| 1597 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 1598 | # +optional |
| 1599 | "namespace": "A String", # Namespace of the referent. |
| 1600 | # More info: |
| 1601 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 1602 | # +optional |
| 1603 | "kind": "A String", # Kind of the referent. |
| 1604 | # More info: |
| 1605 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1606 | # +optional |
| 1607 | }, |
| 1608 | }, |
| 1609 | "data": "A String", # Data to send in the payload of the Event. |
| 1610 | }, |
| 1611 | "kind": "A String", # The kind of resource, in this case "CloudSchedulerSource". |
| 1612 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudSchedulerSource. |
| 1613 | # all objects users must create. |
| 1614 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 1615 | # |
| 1616 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1617 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1618 | # used, the name returned to the client will be different than the name |
| 1619 | # passed. This value will also be combined with a unique suffix. The provided |
| 1620 | # value has the same validation rules as the Name field, and may be truncated |
| 1621 | # by the length of the suffix required to make the value unique on the |
| 1622 | # server. |
| 1623 | # |
| 1624 | # If this field is specified and the generated name exists, the server will |
| 1625 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1626 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1627 | # time allotted, and the client should retry (optionally after the time |
| 1628 | # indicated in the Retry-After header). |
| 1629 | # |
| 1630 | # Applied only if Name is not specified. |
| 1631 | # More info: |
| 1632 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1633 | # +optional |
| 1634 | # string generateName = 2; |
| 1635 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1636 | # Is required when creating |
| 1637 | # resources, although some resources may allow a client to request the |
| 1638 | # generation of an appropriate name automatically. Name is primarily intended |
| 1639 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1640 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1641 | # +optional |
| 1642 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 1643 | # |
| 1644 | # Number of seconds allowed for this object to gracefully terminate before |
| 1645 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1646 | # set. May only be shortened. Read-only. +optional |
| 1647 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 1648 | # |
| 1649 | # The name of the cluster which the object belongs to. |
| 1650 | # This is used to distinguish resources with same name and namespace in |
| 1651 | # different clusters. This field is not set anywhere right now and apiserver |
| 1652 | # is going to ignore it if set in create or update request. +optional |
| 1653 | "finalizers": [ # Not currently supported by Cloud Run. |
| 1654 | # |
| 1655 | # Must be empty before the object is deleted from the registry. Each entry |
| 1656 | # is an identifier for the responsible component that will remove the entry |
| 1657 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1658 | # in this list can only be removed. |
| 1659 | # +optional |
| 1660 | # +patchStrategy=merge |
| 1661 | "A String", |
| 1662 | ], |
| 1663 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1664 | # deleted. This field is set by the server when a graceful deletion is |
| 1665 | # requested by the user, and is not directly settable by a client. The |
| 1666 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1667 | # and not reachable by name) after the time in this field, once the |
| 1668 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1669 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1670 | # be unset or be set further into the future, although it may be shortened or |
| 1671 | # the resource may be deleted prior to this time. For example, a user may |
| 1672 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1673 | # sending a graceful termination signal to the containers in the pod. After |
| 1674 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1675 | # to the container and after cleanup, remove the pod from the API. In the |
| 1676 | # presence of network partitions, this object may still exist after this |
| 1677 | # timestamp, until an administrator or automated process can determine the |
| 1678 | # resource is fully terminated. |
| 1679 | # If not set, graceful deletion of the object has not been requested. |
| 1680 | # |
| 1681 | # Populated by the system when a graceful deletion is requested. |
| 1682 | # Read-only. |
| 1683 | # More info: |
| 1684 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1685 | # +optional |
| 1686 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 1687 | # been deleted, this object will be garbage collected. |
| 1688 | # +optional |
| 1689 | { # OwnerReference contains enough information to let you identify an owning |
| 1690 | # object. Currently, an owning object must be in the same namespace, so there |
| 1691 | # is no namespace field. |
| 1692 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1693 | # +optional |
| 1694 | "kind": "A String", # Kind of the referent. |
| 1695 | # More info: |
| 1696 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1697 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1698 | # the owner cannot be deleted from the key-value store until this |
| 1699 | # reference is removed. |
| 1700 | # Defaults to false. |
| 1701 | # To set this field, a user needs "delete" permission of the owner, |
| 1702 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1703 | # +optional |
| 1704 | "apiVersion": "A String", # API version of the referent. |
| 1705 | "name": "A String", # Name of the referent. |
| 1706 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1707 | "uid": "A String", # UID of the referent. |
| 1708 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1709 | }, |
| 1710 | ], |
| 1711 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 1712 | # object was created. It is not guaranteed to be set in happens-before order |
| 1713 | # across separate operations. Clients may not set this value. It is |
| 1714 | # represented in RFC3339 form and is in UTC. |
| 1715 | # |
| 1716 | # Populated by the system. |
| 1717 | # Read-only. |
| 1718 | # Null for lists. |
| 1719 | # More info: |
| 1720 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1721 | # +optional |
| 1722 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 1723 | # (scope and select) objects. May match selectors of replication controllers |
| 1724 | # and routes. |
| 1725 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1726 | # +optional |
| 1727 | "a_key": "A String", |
| 1728 | }, |
| 1729 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 1730 | # Populated by the system. Read-only. |
| 1731 | # +optional |
| 1732 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 1733 | # can be used by clients to determine when objects have changed. May be used |
| 1734 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1735 | # resource or set of resources. Clients must treat these values as opaque and |
| 1736 | # passed unmodified back to the server. They may only be valid for a |
| 1737 | # particular resource or set of resources. |
| 1738 | # |
| 1739 | # Populated by the system. |
| 1740 | # Read-only. |
| 1741 | # Value must be treated as opaque by clients and . |
| 1742 | # More info: |
| 1743 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1744 | # +optional |
| 1745 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 1746 | # Populated by the system. |
| 1747 | # Read-only. |
| 1748 | # +optional |
| 1749 | # string selfLink = 4; |
| 1750 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 1751 | # generated by the server on successful creation of a resource and is not |
| 1752 | # allowed to change on PUT operations. |
| 1753 | # |
| 1754 | # Populated by the system. |
| 1755 | # Read-only. |
| 1756 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1757 | # +optional |
| 1758 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1759 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1760 | # project ID or project number. |
| 1761 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 1762 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1763 | # are not queryable and should be preserved when modifying objects. More |
| 1764 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 1765 | "a_key": "A String", |
| 1766 | }, |
| 1767 | }, |
| 1768 | } |
| 1769 | |
| 1770 | x__xgafv: string, V1 error format. |
| 1771 | Allowed values |
| 1772 | 1 - v1 error format |
| 1773 | 2 - v2 error format |
| 1774 | |
| 1775 | Returns: |
| 1776 | An object of the form: |
| 1777 | |
| 1778 | { # The CloudSchedulerSource resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1779 | "status": { # CloudSchedulerSourceStatus represents the current state of a # Status represents the current state of the CloudSchedulerSource. This data |
| 1780 | # may be out of date. |
| 1781 | # CloudSchedulerSource. |
| 1782 | "conditions": [ # Array of observed CloudSchedulerSourceConditions, indicating the current |
| 1783 | # state of the CloudSchedulerSource. |
| 1784 | { # Condition defines a generic condition for a Resource |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1785 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 1786 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 1787 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1788 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 1789 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 1790 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 1791 | # See also: |
| 1792 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 1793 | # Types common to all resources include: |
| 1794 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1795 | }, |
| 1796 | ], |
| 1797 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudSchedulerSource that |
| 1798 | # was last processed by the controller. |
| 1799 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 1800 | # Source. |
| 1801 | }, |
| 1802 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 1803 | "spec": { # The desired state of the CloudSchedulerSource. # Spec defines the desired state of the CloudSchedulerSource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1804 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 1805 | # modifications of the event sent to the sink. |
| 1806 | # format of the CloudEvents produced by the Source. |
| 1807 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 1808 | # event. Each `Extensions` key-value pair are set on the event as an |
| 1809 | # attribute extension independently. |
| 1810 | # +optional |
| 1811 | "a_key": "A String", |
| 1812 | }, |
| 1813 | }, |
| 1814 | "schedule": "A String", # Schedule in cron format, for example: "* * * * *" would be run |
| 1815 | # every minute. |
| 1816 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 1817 | # If not specified, defaults to: |
| 1818 | # Name: google-cloud-key |
| 1819 | # Key: key.json |
| 1820 | # |
| 1821 | # Cloud Run on GKE: supported |
| 1822 | # |
| 1823 | # SecretKeySelector selects a key of a Secret. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1824 | "optional": True or False, # Cloud Run fully managed: not supported |
| 1825 | # |
| 1826 | # Cloud Run on GKE: supported |
| 1827 | # |
| 1828 | # Specify whether the Secret or its key must be defined |
| 1829 | # +optional |
| 1830 | "key": "A String", # Cloud Run fully managed: not supported |
| 1831 | # |
| 1832 | # Cloud Run on GKE: supported |
| 1833 | # |
| 1834 | # The key of the secret to select from. Must be a valid secret key. |
| 1835 | "name": "A String", # Cloud Run fully managed: not supported |
| 1836 | # |
| 1837 | # Cloud Run on GKE: supported |
| 1838 | # |
| 1839 | # The name of the secret in the pod's namespace to select from. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1840 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 1841 | # directly into the message. Use the "name" field instead. |
| 1842 | # referenced object inside the same namespace. |
| 1843 | "name": "A String", # Name of the referent. |
| 1844 | # More info: |
| 1845 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1846 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1847 | }, |
| 1848 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 1849 | # Topic exists in. If omitted, defaults to same as the cluster. |
| 1850 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 1851 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 1852 | # |
| 1853 | # Cloud Run on GKE: supported |
| 1854 | # |
| 1855 | # SecretKeySelector selects a key of a Secret. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1856 | "optional": True or False, # Cloud Run fully managed: not supported |
| 1857 | # |
| 1858 | # Cloud Run on GKE: supported |
| 1859 | # |
| 1860 | # Specify whether the Secret or its key must be defined |
| 1861 | # +optional |
| 1862 | "key": "A String", # Cloud Run fully managed: not supported |
| 1863 | # |
| 1864 | # Cloud Run on GKE: supported |
| 1865 | # |
| 1866 | # The key of the secret to select from. Must be a valid secret key. |
| 1867 | "name": "A String", # Cloud Run fully managed: not supported |
| 1868 | # |
| 1869 | # Cloud Run on GKE: supported |
| 1870 | # |
| 1871 | # The name of the secret in the pod's namespace to select from. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1872 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 1873 | # directly into the message. Use the "name" field instead. |
| 1874 | # referenced object inside the same namespace. |
| 1875 | "name": "A String", # Name of the referent. |
| 1876 | # More info: |
| 1877 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1878 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1879 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1880 | "location": "A String", # Location to create the Scheduler job in. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1881 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 1882 | # URI directly to use as the sink. |
| 1883 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 1884 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 1885 | # appended to the path of the resulting URL from the Addressable. |
| 1886 | # + optional |
| 1887 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 1888 | # + optional |
| 1889 | # referred object. |
| 1890 | "apiVersion": "A String", # API version of the referent. |
| 1891 | # +optional |
| 1892 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 1893 | # More info: |
| 1894 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1895 | # +optional |
| 1896 | "name": "A String", # Name of the referent. |
| 1897 | # More info: |
| 1898 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1899 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1900 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 1901 | # string should contain a valid JSON/Go field access statement, such as |
| 1902 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 1903 | # is to a container within a pod, this would take on a value like: |
| 1904 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 1905 | # that triggered the event) or if no container name is specified |
| 1906 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 1907 | # chosen only to have some well-defined way of referencing a part of an |
| 1908 | # object. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1909 | "uid": "A String", # UID of the referent. |
| 1910 | # More info: |
| 1911 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 1912 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1913 | "namespace": "A String", # Namespace of the referent. |
| 1914 | # More info: |
| 1915 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 1916 | # +optional |
| 1917 | "kind": "A String", # Kind of the referent. |
| 1918 | # More info: |
| 1919 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1920 | # +optional |
| 1921 | }, |
| 1922 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1923 | "data": "A String", # Data to send in the payload of the Event. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1924 | }, |
| 1925 | "kind": "A String", # The kind of resource, in this case "CloudSchedulerSource". |
| 1926 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudSchedulerSource. |
| 1927 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1928 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 1929 | # |
| 1930 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1931 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1932 | # used, the name returned to the client will be different than the name |
| 1933 | # passed. This value will also be combined with a unique suffix. The provided |
| 1934 | # value has the same validation rules as the Name field, and may be truncated |
| 1935 | # by the length of the suffix required to make the value unique on the |
| 1936 | # server. |
| 1937 | # |
| 1938 | # If this field is specified and the generated name exists, the server will |
| 1939 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1940 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1941 | # time allotted, and the client should retry (optionally after the time |
| 1942 | # indicated in the Retry-After header). |
| 1943 | # |
| 1944 | # Applied only if Name is not specified. |
| 1945 | # More info: |
| 1946 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1947 | # +optional |
| 1948 | # string generateName = 2; |
| 1949 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1950 | # Is required when creating |
| 1951 | # resources, although some resources may allow a client to request the |
| 1952 | # generation of an appropriate name automatically. Name is primarily intended |
| 1953 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1954 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1955 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1956 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 1957 | # |
| 1958 | # Number of seconds allowed for this object to gracefully terminate before |
| 1959 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1960 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1961 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 1962 | # |
| 1963 | # The name of the cluster which the object belongs to. |
| 1964 | # This is used to distinguish resources with same name and namespace in |
| 1965 | # different clusters. This field is not set anywhere right now and apiserver |
| 1966 | # is going to ignore it if set in create or update request. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1967 | "finalizers": [ # Not currently supported by Cloud Run. |
| 1968 | # |
| 1969 | # Must be empty before the object is deleted from the registry. Each entry |
| 1970 | # is an identifier for the responsible component that will remove the entry |
| 1971 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1972 | # in this list can only be removed. |
| 1973 | # +optional |
| 1974 | # +patchStrategy=merge |
| 1975 | "A String", |
| 1976 | ], |
| 1977 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1978 | # deleted. This field is set by the server when a graceful deletion is |
| 1979 | # requested by the user, and is not directly settable by a client. The |
| 1980 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1981 | # and not reachable by name) after the time in this field, once the |
| 1982 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1983 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1984 | # be unset or be set further into the future, although it may be shortened or |
| 1985 | # the resource may be deleted prior to this time. For example, a user may |
| 1986 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1987 | # sending a graceful termination signal to the containers in the pod. After |
| 1988 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1989 | # to the container and after cleanup, remove the pod from the API. In the |
| 1990 | # presence of network partitions, this object may still exist after this |
| 1991 | # timestamp, until an administrator or automated process can determine the |
| 1992 | # resource is fully terminated. |
| 1993 | # If not set, graceful deletion of the object has not been requested. |
| 1994 | # |
| 1995 | # Populated by the system when a graceful deletion is requested. |
| 1996 | # Read-only. |
| 1997 | # More info: |
| 1998 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1999 | # +optional |
| 2000 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 2001 | # been deleted, this object will be garbage collected. |
| 2002 | # +optional |
| 2003 | { # OwnerReference contains enough information to let you identify an owning |
| 2004 | # object. Currently, an owning object must be in the same namespace, so there |
| 2005 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2006 | "controller": True or False, # If true, this reference points to the managing controller. |
| 2007 | # +optional |
| 2008 | "kind": "A String", # Kind of the referent. |
| 2009 | # More info: |
| 2010 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 2011 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 2012 | # the owner cannot be deleted from the key-value store until this |
| 2013 | # reference is removed. |
| 2014 | # Defaults to false. |
| 2015 | # To set this field, a user needs "delete" permission of the owner, |
| 2016 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 2017 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 2018 | "apiVersion": "A String", # API version of the referent. |
| 2019 | "name": "A String", # Name of the referent. |
| 2020 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 2021 | "uid": "A String", # UID of the referent. |
| 2022 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2023 | }, |
| 2024 | ], |
| 2025 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 2026 | # object was created. It is not guaranteed to be set in happens-before order |
| 2027 | # across separate operations. Clients may not set this value. It is |
| 2028 | # represented in RFC3339 form and is in UTC. |
| 2029 | # |
| 2030 | # Populated by the system. |
| 2031 | # Read-only. |
| 2032 | # Null for lists. |
| 2033 | # More info: |
| 2034 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 2035 | # +optional |
| 2036 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 2037 | # (scope and select) objects. May match selectors of replication controllers |
| 2038 | # and routes. |
| 2039 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 2040 | # +optional |
| 2041 | "a_key": "A String", |
| 2042 | }, |
| 2043 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 2044 | # Populated by the system. Read-only. |
| 2045 | # +optional |
| 2046 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 2047 | # can be used by clients to determine when objects have changed. May be used |
| 2048 | # for optimistic concurrency, change detection, and the watch operation on a |
| 2049 | # resource or set of resources. Clients must treat these values as opaque and |
| 2050 | # passed unmodified back to the server. They may only be valid for a |
| 2051 | # particular resource or set of resources. |
| 2052 | # |
| 2053 | # Populated by the system. |
| 2054 | # Read-only. |
| 2055 | # Value must be treated as opaque by clients and . |
| 2056 | # More info: |
| 2057 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 2058 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 2059 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 2060 | # Populated by the system. |
| 2061 | # Read-only. |
| 2062 | # +optional |
| 2063 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2064 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 2065 | # generated by the server on successful creation of a resource and is not |
| 2066 | # allowed to change on PUT operations. |
| 2067 | # |
| 2068 | # Populated by the system. |
| 2069 | # Read-only. |
| 2070 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 2071 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2072 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 2073 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 2074 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 2075 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 2076 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 2077 | # are not queryable and should be preserved when modifying objects. More |
| 2078 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 2079 | "a_key": "A String", |
| 2080 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2081 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 2082 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2083 | </div> |
| 2084 | |
| 2085 | </body></html> |