| 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.cloudpubsubsources.html">cloudpubsubsources</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 cloudpubsubsource.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Rpc to delete a cloudpubsubsource.</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 cloudpubsubsource.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(parent, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, continue=None, limit=None, watch=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Rpc to list cloudpubsubsources.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 92 | <pre>Creates a new cloudpubsubsource. |
| 93 | |
| 94 | Args: |
| 95 | parent: string, The project ID or project number in which this cloudpubsubsource should |
| 96 | be created. (required) |
| 97 | body: object, The request body. |
| 98 | The object takes the form of: |
| 99 | |
| 100 | { |
| 101 | "status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may |
| 102 | # be out of date. +optional |
| 103 | "conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state |
| 104 | # of the CloudPubSubSource. |
| 105 | { # Condition defines a generic condition for a Resource |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 106 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 107 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 108 | "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] | 109 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 110 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 111 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 112 | # See also: |
| 113 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 114 | # Types common to all resources include: |
| 115 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | }, |
| 117 | ], |
| 118 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that |
| 119 | # was last processed by the controller. |
| 120 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 121 | # Source. |
| 122 | # +optional |
| 123 | }, |
| 124 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 125 | "spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 126 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 127 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 128 | # |
| 129 | # Cloud Run on GKE: supported |
| 130 | # |
| 131 | # SecretKeySelector selects a key of a Secret. |
| 132 | "optional": True or False, # Cloud Run fully managed: not supported |
| 133 | # |
| 134 | # Cloud Run on GKE: supported |
| 135 | # |
| 136 | # Specify whether the Secret or its key must be defined |
| 137 | # +optional |
| 138 | "key": "A String", # Cloud Run fully managed: not supported |
| 139 | # |
| 140 | # Cloud Run on GKE: supported |
| 141 | # |
| 142 | # The key of the secret to select from. Must be a valid secret key. |
| 143 | "name": "A String", # Cloud Run fully managed: not supported |
| 144 | # |
| 145 | # Cloud Run on GKE: supported |
| 146 | # |
| 147 | # The name of the secret in the pod's namespace to select from. |
| 148 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 149 | # directly into the message. Use the "name" field instead. |
| 150 | # referenced object inside the same namespace. |
| 151 | "name": "A String", # Name of the referent. |
| 152 | # More info: |
| 153 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 154 | }, |
| 155 | }, |
| 156 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 157 | # URI directly to use as the sink. |
| 158 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 159 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 160 | # appended to the path of the resulting URL from the Addressable. |
| 161 | # + optional |
| 162 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 163 | # + optional |
| 164 | # referred object. |
| 165 | "apiVersion": "A String", # API version of the referent. |
| 166 | # +optional |
| 167 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 168 | # More info: |
| 169 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 170 | # +optional |
| 171 | "name": "A String", # Name of the referent. |
| 172 | # More info: |
| 173 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 174 | # +optional |
| 175 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 176 | # string should contain a valid JSON/Go field access statement, such as |
| 177 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 178 | # is to a container within a pod, this would take on a value like: |
| 179 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 180 | # that triggered the event) or if no container name is specified |
| 181 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 182 | # chosen only to have some well-defined way of referencing a part of an |
| 183 | # object. |
| 184 | "uid": "A String", # UID of the referent. |
| 185 | # More info: |
| 186 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 187 | # +optional |
| 188 | "namespace": "A String", # Namespace of the referent. |
| 189 | # More info: |
| 190 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 191 | # +optional |
| 192 | "kind": "A String", # Kind of the referent. |
| 193 | # More info: |
| 194 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 195 | # +optional |
| 196 | }, |
| 197 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 198 | "retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If |
| 199 | # true, acknowledged messages will not be expunged until they fall out of |
| 200 | # the RetentionDuration window. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 201 | "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a |
| 202 | # message before the subscriber should acknowledge the message. Defaults |
| 203 | # to 30 seconds ('30s'). |
| 204 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 205 | "retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from |
| 206 | # the time of publish. If RetainAckedMessages is true, this duration |
| 207 | # affects the retention of acknowledged messages, otherwise only |
| 208 | # unacknowledged messages are retained. Cannot be longer than 7 days or |
| 209 | # shorter than 10 minutes. Defaults to 7 days ('7d'). |
| 210 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 211 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 212 | # modifications of the event sent to the sink. |
| 213 | # +optional |
| 214 | # format of the CloudEvents produced by the Source. |
| 215 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 216 | # event. Each `Extensions` key-value pair are set on the event as an |
| 217 | # attribute extension independently. |
| 218 | # +optional |
| 219 | "a_key": "A String", |
| 220 | }, |
| 221 | }, |
| 222 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 223 | # If not specified, defaults to: |
| 224 | # Name: google-cloud-key |
| 225 | # Key: key.json |
| 226 | # +optional |
| 227 | # |
| 228 | # Cloud Run on GKE: supported |
| 229 | # |
| 230 | # SecretKeySelector selects a key of a Secret. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 231 | "optional": True or False, # Cloud Run fully managed: not supported |
| 232 | # |
| 233 | # Cloud Run on GKE: supported |
| 234 | # |
| 235 | # Specify whether the Secret or its key must be defined |
| 236 | # +optional |
| 237 | "key": "A String", # Cloud Run fully managed: not supported |
| 238 | # |
| 239 | # Cloud Run on GKE: supported |
| 240 | # |
| 241 | # The key of the secret to select from. Must be a valid secret key. |
| 242 | "name": "A String", # Cloud Run fully managed: not supported |
| 243 | # |
| 244 | # Cloud Run on GKE: supported |
| 245 | # |
| 246 | # 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] | 247 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 248 | # directly into the message. Use the "name" field instead. |
| 249 | # referenced object inside the same namespace. |
| 250 | "name": "A String", # Name of the referent. |
| 251 | # More info: |
| 252 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 253 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 254 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 255 | "topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must |
| 256 | # be in the form of the unique identifier within the project, not the |
| 257 | # entire name. E.g. it must be 'laconia', not |
| 258 | # 'projects/my-proj/topics/laconia'. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 259 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 260 | # Topic exists in. If omitted, defaults to same as the cluster. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | }, |
| 262 | "kind": "A String", # The kind of resource, in this case "CloudPubSubSource". |
| 263 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudPubSubSource. |
| 264 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 265 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 266 | # |
| 267 | # GenerateName is an optional prefix, used by the server, to generate a |
| 268 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 269 | # used, the name returned to the client will be different than the name |
| 270 | # passed. This value will also be combined with a unique suffix. The provided |
| 271 | # value has the same validation rules as the Name field, and may be truncated |
| 272 | # by the length of the suffix required to make the value unique on the |
| 273 | # server. |
| 274 | # |
| 275 | # If this field is specified and the generated name exists, the server will |
| 276 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 277 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 278 | # time allotted, and the client should retry (optionally after the time |
| 279 | # indicated in the Retry-After header). |
| 280 | # |
| 281 | # Applied only if Name is not specified. |
| 282 | # More info: |
| 283 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 284 | # +optional |
| 285 | # string generateName = 2; |
| 286 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 287 | # Is required when creating |
| 288 | # resources, although some resources may allow a client to request the |
| 289 | # generation of an appropriate name automatically. Name is primarily intended |
| 290 | # for creation idempotence and configuration definition. Cannot be updated. |
| 291 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 292 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 293 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 294 | # |
| 295 | # Number of seconds allowed for this object to gracefully terminate before |
| 296 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 297 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 298 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 299 | # |
| 300 | # The name of the cluster which the object belongs to. |
| 301 | # This is used to distinguish resources with same name and namespace in |
| 302 | # different clusters. This field is not set anywhere right now and apiserver |
| 303 | # 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] | 304 | "finalizers": [ # Not currently supported by Cloud Run. |
| 305 | # |
| 306 | # Must be empty before the object is deleted from the registry. Each entry |
| 307 | # is an identifier for the responsible component that will remove the entry |
| 308 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 309 | # in this list can only be removed. |
| 310 | # +optional |
| 311 | # +patchStrategy=merge |
| 312 | "A String", |
| 313 | ], |
| 314 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 315 | # deleted. This field is set by the server when a graceful deletion is |
| 316 | # requested by the user, and is not directly settable by a client. The |
| 317 | # resource is expected to be deleted (no longer visible from resource lists, |
| 318 | # and not reachable by name) after the time in this field, once the |
| 319 | # finalizers list is empty. As long as the finalizers list contains items, |
| 320 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 321 | # be unset or be set further into the future, although it may be shortened or |
| 322 | # the resource may be deleted prior to this time. For example, a user may |
| 323 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 324 | # sending a graceful termination signal to the containers in the pod. After |
| 325 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 326 | # to the container and after cleanup, remove the pod from the API. In the |
| 327 | # presence of network partitions, this object may still exist after this |
| 328 | # timestamp, until an administrator or automated process can determine the |
| 329 | # resource is fully terminated. |
| 330 | # If not set, graceful deletion of the object has not been requested. |
| 331 | # |
| 332 | # Populated by the system when a graceful deletion is requested. |
| 333 | # Read-only. |
| 334 | # More info: |
| 335 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 336 | # +optional |
| 337 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 338 | # been deleted, this object will be garbage collected. |
| 339 | # +optional |
| 340 | { # OwnerReference contains enough information to let you identify an owning |
| 341 | # object. Currently, an owning object must be in the same namespace, so there |
| 342 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 343 | "controller": True or False, # If true, this reference points to the managing controller. |
| 344 | # +optional |
| 345 | "kind": "A String", # Kind of the referent. |
| 346 | # More info: |
| 347 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 348 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 349 | # the owner cannot be deleted from the key-value store until this |
| 350 | # reference is removed. |
| 351 | # Defaults to false. |
| 352 | # To set this field, a user needs "delete" permission of the owner, |
| 353 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 354 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 355 | "apiVersion": "A String", # API version of the referent. |
| 356 | "name": "A String", # Name of the referent. |
| 357 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 358 | "uid": "A String", # UID of the referent. |
| 359 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | }, |
| 361 | ], |
| 362 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 363 | # object was created. It is not guaranteed to be set in happens-before order |
| 364 | # across separate operations. Clients may not set this value. It is |
| 365 | # represented in RFC3339 form and is in UTC. |
| 366 | # |
| 367 | # Populated by the system. |
| 368 | # Read-only. |
| 369 | # Null for lists. |
| 370 | # More info: |
| 371 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 372 | # +optional |
| 373 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 374 | # (scope and select) objects. May match selectors of replication controllers |
| 375 | # and routes. |
| 376 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 377 | # +optional |
| 378 | "a_key": "A String", |
| 379 | }, |
| 380 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 381 | # Populated by the system. Read-only. |
| 382 | # +optional |
| 383 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 384 | # can be used by clients to determine when objects have changed. May be used |
| 385 | # for optimistic concurrency, change detection, and the watch operation on a |
| 386 | # resource or set of resources. Clients must treat these values as opaque and |
| 387 | # passed unmodified back to the server. They may only be valid for a |
| 388 | # particular resource or set of resources. |
| 389 | # |
| 390 | # Populated by the system. |
| 391 | # Read-only. |
| 392 | # Value must be treated as opaque by clients and . |
| 393 | # More info: |
| 394 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 395 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 396 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 397 | # Populated by the system. |
| 398 | # Read-only. |
| 399 | # +optional |
| 400 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 401 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 402 | # generated by the server on successful creation of a resource and is not |
| 403 | # allowed to change on PUT operations. |
| 404 | # |
| 405 | # Populated by the system. |
| 406 | # Read-only. |
| 407 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 408 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 409 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 410 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 411 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 412 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 413 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 414 | # are not queryable and should be preserved when modifying objects. More |
| 415 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 416 | "a_key": "A String", |
| 417 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 418 | }, |
| 419 | } |
| 420 | |
| 421 | x__xgafv: string, V1 error format. |
| 422 | Allowed values |
| 423 | 1 - v1 error format |
| 424 | 2 - v2 error format |
| 425 | |
| 426 | Returns: |
| 427 | An object of the form: |
| 428 | |
| 429 | { |
| 430 | "status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may |
| 431 | # be out of date. +optional |
| 432 | "conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state |
| 433 | # of the CloudPubSubSource. |
| 434 | { # Condition defines a generic condition for a Resource |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 435 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 436 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 437 | "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] | 438 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 439 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 440 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 441 | # See also: |
| 442 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 443 | # Types common to all resources include: |
| 444 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 445 | }, |
| 446 | ], |
| 447 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that |
| 448 | # was last processed by the controller. |
| 449 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 450 | # Source. |
| 451 | # +optional |
| 452 | }, |
| 453 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 454 | "spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 455 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 456 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 457 | # |
| 458 | # Cloud Run on GKE: supported |
| 459 | # |
| 460 | # SecretKeySelector selects a key of a Secret. |
| 461 | "optional": True or False, # Cloud Run fully managed: not supported |
| 462 | # |
| 463 | # Cloud Run on GKE: supported |
| 464 | # |
| 465 | # Specify whether the Secret or its key must be defined |
| 466 | # +optional |
| 467 | "key": "A String", # Cloud Run fully managed: not supported |
| 468 | # |
| 469 | # Cloud Run on GKE: supported |
| 470 | # |
| 471 | # The key of the secret to select from. Must be a valid secret key. |
| 472 | "name": "A String", # Cloud Run fully managed: not supported |
| 473 | # |
| 474 | # Cloud Run on GKE: supported |
| 475 | # |
| 476 | # The name of the secret in the pod's namespace to select from. |
| 477 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 478 | # directly into the message. Use the "name" field instead. |
| 479 | # referenced object inside the same namespace. |
| 480 | "name": "A String", # Name of the referent. |
| 481 | # More info: |
| 482 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 483 | }, |
| 484 | }, |
| 485 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 486 | # URI directly to use as the sink. |
| 487 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 488 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 489 | # appended to the path of the resulting URL from the Addressable. |
| 490 | # + optional |
| 491 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 492 | # + optional |
| 493 | # referred object. |
| 494 | "apiVersion": "A String", # API version of the referent. |
| 495 | # +optional |
| 496 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 497 | # More info: |
| 498 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 499 | # +optional |
| 500 | "name": "A String", # Name of the referent. |
| 501 | # More info: |
| 502 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 503 | # +optional |
| 504 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 505 | # string should contain a valid JSON/Go field access statement, such as |
| 506 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 507 | # is to a container within a pod, this would take on a value like: |
| 508 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 509 | # that triggered the event) or if no container name is specified |
| 510 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 511 | # chosen only to have some well-defined way of referencing a part of an |
| 512 | # object. |
| 513 | "uid": "A String", # UID of the referent. |
| 514 | # More info: |
| 515 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 516 | # +optional |
| 517 | "namespace": "A String", # Namespace of the referent. |
| 518 | # More info: |
| 519 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 520 | # +optional |
| 521 | "kind": "A String", # Kind of the referent. |
| 522 | # More info: |
| 523 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 524 | # +optional |
| 525 | }, |
| 526 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 527 | "retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If |
| 528 | # true, acknowledged messages will not be expunged until they fall out of |
| 529 | # the RetentionDuration window. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 530 | "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a |
| 531 | # message before the subscriber should acknowledge the message. Defaults |
| 532 | # to 30 seconds ('30s'). |
| 533 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 534 | "retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from |
| 535 | # the time of publish. If RetainAckedMessages is true, this duration |
| 536 | # affects the retention of acknowledged messages, otherwise only |
| 537 | # unacknowledged messages are retained. Cannot be longer than 7 days or |
| 538 | # shorter than 10 minutes. Defaults to 7 days ('7d'). |
| 539 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 540 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 541 | # modifications of the event sent to the sink. |
| 542 | # +optional |
| 543 | # format of the CloudEvents produced by the Source. |
| 544 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 545 | # event. Each `Extensions` key-value pair are set on the event as an |
| 546 | # attribute extension independently. |
| 547 | # +optional |
| 548 | "a_key": "A String", |
| 549 | }, |
| 550 | }, |
| 551 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 552 | # If not specified, defaults to: |
| 553 | # Name: google-cloud-key |
| 554 | # Key: key.json |
| 555 | # +optional |
| 556 | # |
| 557 | # Cloud Run on GKE: supported |
| 558 | # |
| 559 | # SecretKeySelector selects a key of a Secret. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 560 | "optional": True or False, # Cloud Run fully managed: not supported |
| 561 | # |
| 562 | # Cloud Run on GKE: supported |
| 563 | # |
| 564 | # Specify whether the Secret or its key must be defined |
| 565 | # +optional |
| 566 | "key": "A String", # Cloud Run fully managed: not supported |
| 567 | # |
| 568 | # Cloud Run on GKE: supported |
| 569 | # |
| 570 | # The key of the secret to select from. Must be a valid secret key. |
| 571 | "name": "A String", # Cloud Run fully managed: not supported |
| 572 | # |
| 573 | # Cloud Run on GKE: supported |
| 574 | # |
| 575 | # 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] | 576 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 577 | # directly into the message. Use the "name" field instead. |
| 578 | # referenced object inside the same namespace. |
| 579 | "name": "A String", # Name of the referent. |
| 580 | # More info: |
| 581 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 582 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 583 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 584 | "topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must |
| 585 | # be in the form of the unique identifier within the project, not the |
| 586 | # entire name. E.g. it must be 'laconia', not |
| 587 | # 'projects/my-proj/topics/laconia'. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 588 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 589 | # Topic exists in. If omitted, defaults to same as the cluster. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 590 | }, |
| 591 | "kind": "A String", # The kind of resource, in this case "CloudPubSubSource". |
| 592 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudPubSubSource. |
| 593 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 594 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 595 | # |
| 596 | # GenerateName is an optional prefix, used by the server, to generate a |
| 597 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 598 | # used, the name returned to the client will be different than the name |
| 599 | # passed. This value will also be combined with a unique suffix. The provided |
| 600 | # value has the same validation rules as the Name field, and may be truncated |
| 601 | # by the length of the suffix required to make the value unique on the |
| 602 | # server. |
| 603 | # |
| 604 | # If this field is specified and the generated name exists, the server will |
| 605 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 606 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 607 | # time allotted, and the client should retry (optionally after the time |
| 608 | # indicated in the Retry-After header). |
| 609 | # |
| 610 | # Applied only if Name is not specified. |
| 611 | # More info: |
| 612 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 613 | # +optional |
| 614 | # string generateName = 2; |
| 615 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 616 | # Is required when creating |
| 617 | # resources, although some resources may allow a client to request the |
| 618 | # generation of an appropriate name automatically. Name is primarily intended |
| 619 | # for creation idempotence and configuration definition. Cannot be updated. |
| 620 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 621 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 622 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 623 | # |
| 624 | # Number of seconds allowed for this object to gracefully terminate before |
| 625 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 626 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 627 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 628 | # |
| 629 | # The name of the cluster which the object belongs to. |
| 630 | # This is used to distinguish resources with same name and namespace in |
| 631 | # different clusters. This field is not set anywhere right now and apiserver |
| 632 | # 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] | 633 | "finalizers": [ # Not currently supported by Cloud Run. |
| 634 | # |
| 635 | # Must be empty before the object is deleted from the registry. Each entry |
| 636 | # is an identifier for the responsible component that will remove the entry |
| 637 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 638 | # in this list can only be removed. |
| 639 | # +optional |
| 640 | # +patchStrategy=merge |
| 641 | "A String", |
| 642 | ], |
| 643 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 644 | # deleted. This field is set by the server when a graceful deletion is |
| 645 | # requested by the user, and is not directly settable by a client. The |
| 646 | # resource is expected to be deleted (no longer visible from resource lists, |
| 647 | # and not reachable by name) after the time in this field, once the |
| 648 | # finalizers list is empty. As long as the finalizers list contains items, |
| 649 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 650 | # be unset or be set further into the future, although it may be shortened or |
| 651 | # the resource may be deleted prior to this time. For example, a user may |
| 652 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 653 | # sending a graceful termination signal to the containers in the pod. After |
| 654 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 655 | # to the container and after cleanup, remove the pod from the API. In the |
| 656 | # presence of network partitions, this object may still exist after this |
| 657 | # timestamp, until an administrator or automated process can determine the |
| 658 | # resource is fully terminated. |
| 659 | # If not set, graceful deletion of the object has not been requested. |
| 660 | # |
| 661 | # Populated by the system when a graceful deletion is requested. |
| 662 | # Read-only. |
| 663 | # More info: |
| 664 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 665 | # +optional |
| 666 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 667 | # been deleted, this object will be garbage collected. |
| 668 | # +optional |
| 669 | { # OwnerReference contains enough information to let you identify an owning |
| 670 | # object. Currently, an owning object must be in the same namespace, so there |
| 671 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 672 | "controller": True or False, # If true, this reference points to the managing controller. |
| 673 | # +optional |
| 674 | "kind": "A String", # Kind of the referent. |
| 675 | # More info: |
| 676 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 677 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 678 | # the owner cannot be deleted from the key-value store until this |
| 679 | # reference is removed. |
| 680 | # Defaults to false. |
| 681 | # To set this field, a user needs "delete" permission of the owner, |
| 682 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 683 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 684 | "apiVersion": "A String", # API version of the referent. |
| 685 | "name": "A String", # Name of the referent. |
| 686 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 687 | "uid": "A String", # UID of the referent. |
| 688 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 689 | }, |
| 690 | ], |
| 691 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 692 | # object was created. It is not guaranteed to be set in happens-before order |
| 693 | # across separate operations. Clients may not set this value. It is |
| 694 | # represented in RFC3339 form and is in UTC. |
| 695 | # |
| 696 | # Populated by the system. |
| 697 | # Read-only. |
| 698 | # Null for lists. |
| 699 | # More info: |
| 700 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 701 | # +optional |
| 702 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 703 | # (scope and select) objects. May match selectors of replication controllers |
| 704 | # and routes. |
| 705 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 706 | # +optional |
| 707 | "a_key": "A String", |
| 708 | }, |
| 709 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 710 | # Populated by the system. Read-only. |
| 711 | # +optional |
| 712 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 713 | # can be used by clients to determine when objects have changed. May be used |
| 714 | # for optimistic concurrency, change detection, and the watch operation on a |
| 715 | # resource or set of resources. Clients must treat these values as opaque and |
| 716 | # passed unmodified back to the server. They may only be valid for a |
| 717 | # particular resource or set of resources. |
| 718 | # |
| 719 | # Populated by the system. |
| 720 | # Read-only. |
| 721 | # Value must be treated as opaque by clients and . |
| 722 | # More info: |
| 723 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 724 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 725 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 726 | # Populated by the system. |
| 727 | # Read-only. |
| 728 | # +optional |
| 729 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 730 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 731 | # generated by the server on successful creation of a resource and is not |
| 732 | # allowed to change on PUT operations. |
| 733 | # |
| 734 | # Populated by the system. |
| 735 | # Read-only. |
| 736 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 737 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 738 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 739 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 740 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 741 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 742 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 743 | # are not queryable and should be preserved when modifying objects. More |
| 744 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 745 | "a_key": "A String", |
| 746 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 747 | }, |
| 748 | }</pre> |
| 749 | </div> |
| 750 | |
| 751 | <div class="method"> |
| 752 | <code class="details" id="delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code> |
| 753 | <pre>Rpc to delete a cloudpubsubsource. |
| 754 | |
| 755 | Args: |
| 756 | name: string, The name of the cloudpubsubsource being deleted. If needed, replace |
| 757 | {namespace_id} with the project ID. (required) |
| 758 | apiVersion: string, Cloud Run currently ignores this parameter. |
| 759 | propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores |
| 760 | this setting, and deletes in the background. Please see |
| 761 | kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for |
| 762 | more information. |
| 763 | kind: string, Cloud Run currently ignores this parameter. |
| 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 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 773 | # empty messages in your APIs. A typical example is to use it as the request |
| 774 | # or the response type of an API method. For instance: |
| 775 | # |
| 776 | # service Foo { |
| 777 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 778 | # } |
| 779 | # |
| 780 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 781 | }</pre> |
| 782 | </div> |
| 783 | |
| 784 | <div class="method"> |
| 785 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 786 | <pre>Rpc to get information about a cloudpubsubsource. |
| 787 | |
| 788 | Args: |
| 789 | name: string, The name of the cloudpubsubsource being retrieved. If needed, replace |
| 790 | {namespace_id} with the project ID. (required) |
| 791 | x__xgafv: string, V1 error format. |
| 792 | Allowed values |
| 793 | 1 - v1 error format |
| 794 | 2 - v2 error format |
| 795 | |
| 796 | Returns: |
| 797 | An object of the form: |
| 798 | |
| 799 | { |
| 800 | "status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may |
| 801 | # be out of date. +optional |
| 802 | "conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state |
| 803 | # of the CloudPubSubSource. |
| 804 | { # Condition defines a generic condition for a Resource |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 805 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 806 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 807 | "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] | 808 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 809 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 810 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 811 | # See also: |
| 812 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 813 | # Types common to all resources include: |
| 814 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 815 | }, |
| 816 | ], |
| 817 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that |
| 818 | # was last processed by the controller. |
| 819 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 820 | # Source. |
| 821 | # +optional |
| 822 | }, |
| 823 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 824 | "spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 825 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 826 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 827 | # |
| 828 | # Cloud Run on GKE: supported |
| 829 | # |
| 830 | # SecretKeySelector selects a key of a Secret. |
| 831 | "optional": True or False, # Cloud Run fully managed: not supported |
| 832 | # |
| 833 | # Cloud Run on GKE: supported |
| 834 | # |
| 835 | # Specify whether the Secret or its key must be defined |
| 836 | # +optional |
| 837 | "key": "A String", # Cloud Run fully managed: not supported |
| 838 | # |
| 839 | # Cloud Run on GKE: supported |
| 840 | # |
| 841 | # The key of the secret to select from. Must be a valid secret key. |
| 842 | "name": "A String", # Cloud Run fully managed: not supported |
| 843 | # |
| 844 | # Cloud Run on GKE: supported |
| 845 | # |
| 846 | # The name of the secret in the pod's namespace to select from. |
| 847 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 848 | # directly into the message. Use the "name" field instead. |
| 849 | # referenced object inside the same namespace. |
| 850 | "name": "A String", # Name of the referent. |
| 851 | # More info: |
| 852 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 853 | }, |
| 854 | }, |
| 855 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 856 | # URI directly to use as the sink. |
| 857 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 858 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 859 | # appended to the path of the resulting URL from the Addressable. |
| 860 | # + optional |
| 861 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 862 | # + optional |
| 863 | # referred object. |
| 864 | "apiVersion": "A String", # API version of the referent. |
| 865 | # +optional |
| 866 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 867 | # More info: |
| 868 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 869 | # +optional |
| 870 | "name": "A String", # Name of the referent. |
| 871 | # More info: |
| 872 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 873 | # +optional |
| 874 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 875 | # string should contain a valid JSON/Go field access statement, such as |
| 876 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 877 | # is to a container within a pod, this would take on a value like: |
| 878 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 879 | # that triggered the event) or if no container name is specified |
| 880 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 881 | # chosen only to have some well-defined way of referencing a part of an |
| 882 | # object. |
| 883 | "uid": "A String", # UID of the referent. |
| 884 | # More info: |
| 885 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 886 | # +optional |
| 887 | "namespace": "A String", # Namespace of the referent. |
| 888 | # More info: |
| 889 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 890 | # +optional |
| 891 | "kind": "A String", # Kind of the referent. |
| 892 | # More info: |
| 893 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 894 | # +optional |
| 895 | }, |
| 896 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 897 | "retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If |
| 898 | # true, acknowledged messages will not be expunged until they fall out of |
| 899 | # the RetentionDuration window. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 900 | "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a |
| 901 | # message before the subscriber should acknowledge the message. Defaults |
| 902 | # to 30 seconds ('30s'). |
| 903 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 904 | "retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from |
| 905 | # the time of publish. If RetainAckedMessages is true, this duration |
| 906 | # affects the retention of acknowledged messages, otherwise only |
| 907 | # unacknowledged messages are retained. Cannot be longer than 7 days or |
| 908 | # shorter than 10 minutes. Defaults to 7 days ('7d'). |
| 909 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 910 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 911 | # modifications of the event sent to the sink. |
| 912 | # +optional |
| 913 | # format of the CloudEvents produced by the Source. |
| 914 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 915 | # event. Each `Extensions` key-value pair are set on the event as an |
| 916 | # attribute extension independently. |
| 917 | # +optional |
| 918 | "a_key": "A String", |
| 919 | }, |
| 920 | }, |
| 921 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 922 | # If not specified, defaults to: |
| 923 | # Name: google-cloud-key |
| 924 | # Key: key.json |
| 925 | # +optional |
| 926 | # |
| 927 | # Cloud Run on GKE: supported |
| 928 | # |
| 929 | # SecretKeySelector selects a key of a Secret. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 930 | "optional": True or False, # Cloud Run fully managed: not supported |
| 931 | # |
| 932 | # Cloud Run on GKE: supported |
| 933 | # |
| 934 | # Specify whether the Secret or its key must be defined |
| 935 | # +optional |
| 936 | "key": "A String", # Cloud Run fully managed: not supported |
| 937 | # |
| 938 | # Cloud Run on GKE: supported |
| 939 | # |
| 940 | # The key of the secret to select from. Must be a valid secret key. |
| 941 | "name": "A String", # Cloud Run fully managed: not supported |
| 942 | # |
| 943 | # Cloud Run on GKE: supported |
| 944 | # |
| 945 | # 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] | 946 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 947 | # directly into the message. Use the "name" field instead. |
| 948 | # referenced object inside the same namespace. |
| 949 | "name": "A String", # Name of the referent. |
| 950 | # More info: |
| 951 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 952 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 953 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 954 | "topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must |
| 955 | # be in the form of the unique identifier within the project, not the |
| 956 | # entire name. E.g. it must be 'laconia', not |
| 957 | # 'projects/my-proj/topics/laconia'. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 958 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 959 | # Topic exists in. If omitted, defaults to same as the cluster. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 960 | }, |
| 961 | "kind": "A String", # The kind of resource, in this case "CloudPubSubSource". |
| 962 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudPubSubSource. |
| 963 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 964 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 965 | # |
| 966 | # GenerateName is an optional prefix, used by the server, to generate a |
| 967 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 968 | # used, the name returned to the client will be different than the name |
| 969 | # passed. This value will also be combined with a unique suffix. The provided |
| 970 | # value has the same validation rules as the Name field, and may be truncated |
| 971 | # by the length of the suffix required to make the value unique on the |
| 972 | # server. |
| 973 | # |
| 974 | # If this field is specified and the generated name exists, the server will |
| 975 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 976 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 977 | # time allotted, and the client should retry (optionally after the time |
| 978 | # indicated in the Retry-After header). |
| 979 | # |
| 980 | # Applied only if Name is not specified. |
| 981 | # More info: |
| 982 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 983 | # +optional |
| 984 | # string generateName = 2; |
| 985 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 986 | # Is required when creating |
| 987 | # resources, although some resources may allow a client to request the |
| 988 | # generation of an appropriate name automatically. Name is primarily intended |
| 989 | # for creation idempotence and configuration definition. Cannot be updated. |
| 990 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 991 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 992 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 993 | # |
| 994 | # Number of seconds allowed for this object to gracefully terminate before |
| 995 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 996 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 997 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 998 | # |
| 999 | # The name of the cluster which the object belongs to. |
| 1000 | # This is used to distinguish resources with same name and namespace in |
| 1001 | # different clusters. This field is not set anywhere right now and apiserver |
| 1002 | # 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] | 1003 | "finalizers": [ # Not currently supported by Cloud Run. |
| 1004 | # |
| 1005 | # Must be empty before the object is deleted from the registry. Each entry |
| 1006 | # is an identifier for the responsible component that will remove the entry |
| 1007 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1008 | # in this list can only be removed. |
| 1009 | # +optional |
| 1010 | # +patchStrategy=merge |
| 1011 | "A String", |
| 1012 | ], |
| 1013 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1014 | # deleted. This field is set by the server when a graceful deletion is |
| 1015 | # requested by the user, and is not directly settable by a client. The |
| 1016 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1017 | # and not reachable by name) after the time in this field, once the |
| 1018 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1019 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1020 | # be unset or be set further into the future, although it may be shortened or |
| 1021 | # the resource may be deleted prior to this time. For example, a user may |
| 1022 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1023 | # sending a graceful termination signal to the containers in the pod. After |
| 1024 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1025 | # to the container and after cleanup, remove the pod from the API. In the |
| 1026 | # presence of network partitions, this object may still exist after this |
| 1027 | # timestamp, until an administrator or automated process can determine the |
| 1028 | # resource is fully terminated. |
| 1029 | # If not set, graceful deletion of the object has not been requested. |
| 1030 | # |
| 1031 | # Populated by the system when a graceful deletion is requested. |
| 1032 | # Read-only. |
| 1033 | # More info: |
| 1034 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1035 | # +optional |
| 1036 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 1037 | # been deleted, this object will be garbage collected. |
| 1038 | # +optional |
| 1039 | { # OwnerReference contains enough information to let you identify an owning |
| 1040 | # object. Currently, an owning object must be in the same namespace, so there |
| 1041 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1042 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1043 | # +optional |
| 1044 | "kind": "A String", # Kind of the referent. |
| 1045 | # More info: |
| 1046 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1047 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1048 | # the owner cannot be deleted from the key-value store until this |
| 1049 | # reference is removed. |
| 1050 | # Defaults to false. |
| 1051 | # To set this field, a user needs "delete" permission of the owner, |
| 1052 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1053 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1054 | "apiVersion": "A String", # API version of the referent. |
| 1055 | "name": "A String", # Name of the referent. |
| 1056 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1057 | "uid": "A String", # UID of the referent. |
| 1058 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1059 | }, |
| 1060 | ], |
| 1061 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 1062 | # object was created. It is not guaranteed to be set in happens-before order |
| 1063 | # across separate operations. Clients may not set this value. It is |
| 1064 | # represented in RFC3339 form and is in UTC. |
| 1065 | # |
| 1066 | # Populated by the system. |
| 1067 | # Read-only. |
| 1068 | # Null for lists. |
| 1069 | # More info: |
| 1070 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1071 | # +optional |
| 1072 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 1073 | # (scope and select) objects. May match selectors of replication controllers |
| 1074 | # and routes. |
| 1075 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1076 | # +optional |
| 1077 | "a_key": "A String", |
| 1078 | }, |
| 1079 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 1080 | # Populated by the system. Read-only. |
| 1081 | # +optional |
| 1082 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 1083 | # can be used by clients to determine when objects have changed. May be used |
| 1084 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1085 | # resource or set of resources. Clients must treat these values as opaque and |
| 1086 | # passed unmodified back to the server. They may only be valid for a |
| 1087 | # particular resource or set of resources. |
| 1088 | # |
| 1089 | # Populated by the system. |
| 1090 | # Read-only. |
| 1091 | # Value must be treated as opaque by clients and . |
| 1092 | # More info: |
| 1093 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1094 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1095 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 1096 | # Populated by the system. |
| 1097 | # Read-only. |
| 1098 | # +optional |
| 1099 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1100 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 1101 | # generated by the server on successful creation of a resource and is not |
| 1102 | # allowed to change on PUT operations. |
| 1103 | # |
| 1104 | # Populated by the system. |
| 1105 | # Read-only. |
| 1106 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1107 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1108 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1109 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1110 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1111 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 1112 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1113 | # are not queryable and should be preserved when modifying objects. More |
| 1114 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 1115 | "a_key": "A String", |
| 1116 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1117 | }, |
| 1118 | }</pre> |
| 1119 | </div> |
| 1120 | |
| 1121 | <div class="method"> |
| 1122 | <code class="details" id="list">list(parent, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, continue=None, limit=None, watch=None, x__xgafv=None)</code> |
| 1123 | <pre>Rpc to list cloudpubsubsources. |
| 1124 | |
| 1125 | Args: |
| 1126 | parent: string, The project ID or project number from which the cloudpubsubsources should |
| 1127 | be listed. (required) |
| 1128 | labelSelector: string, Allows to filter resources based on a label. Supported operations are |
| 1129 | =, !=, exists, in, and notIn. |
| 1130 | fieldSelector: string, Allows to filter resources based on a specific value for a field name. |
| 1131 | Send this in a query string format. i.e. 'metadata.name%3Dlorem'. |
| 1132 | Not currently used by Cloud Run. |
| 1133 | includeUninitialized: boolean, Not currently used by Cloud Run. |
| 1134 | resourceVersion: string, The baseline resource version from which the list or watch operation should |
| 1135 | start. Not currently used by Cloud Run. |
| 1136 | continue: string, Optional encoded string to continue paging. |
| 1137 | limit: integer, The maximum number of records that should be returned. |
| 1138 | watch: boolean, Flag that indicates that the client expects to watch this resource as well. |
| 1139 | Not currently used by Cloud Run. |
| 1140 | x__xgafv: string, V1 error format. |
| 1141 | Allowed values |
| 1142 | 1 - v1 error format |
| 1143 | 2 - v2 error format |
| 1144 | |
| 1145 | Returns: |
| 1146 | An object of the form: |
| 1147 | |
| 1148 | { # ListCloudPubSubSourcesResponse is a list of CloudPubSubSource resources. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1149 | "kind": "A String", # The kind of this resource, in this case "CloudPubSubSourceList". |
| 1150 | "unreachable": [ # Locations that could not be reached. |
| 1151 | "A String", |
| 1152 | ], |
| 1153 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this CloudPubSubSource list. |
| 1154 | # lists and various status objects. A resource may have only one of |
| 1155 | # {ObjectMeta, ListMeta}. |
| 1156 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| 1157 | # can be used by clients to determine when objects have changed. Value must |
| 1158 | # be treated as opaque by clients and passed unmodified back to the server. |
| 1159 | # Populated by the system. |
| 1160 | # Read-only. |
| 1161 | # More info: |
| 1162 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1163 | # +optional |
| 1164 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 1165 | # returned, and indicates that the server has more data available. The value |
| 1166 | # is opaque and may be used to issue another request to the endpoint that |
| 1167 | # served this list to retrieve the next set of available objects. Continuing |
| 1168 | # a list may not be possible if the server configuration has changed or more |
| 1169 | # than a few minutes have passed. The resourceVersion field returned when |
| 1170 | # using this continue value will be identical to the value in the first |
| 1171 | # response. |
| 1172 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 1173 | # Populated by the system. |
| 1174 | # Read-only. |
| 1175 | # +optional |
| 1176 | }, |
| 1177 | "items": [ # List of CloudPubSubSources. |
| 1178 | { |
| 1179 | "status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may |
| 1180 | # be out of date. +optional |
| 1181 | "conditions": [ # Array of observed CloudPubSubSourceConditions, indicating the current state |
| 1182 | # of the CloudPubSubSource. |
| 1183 | { # Condition defines a generic condition for a Resource |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1184 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 1185 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| 1186 | "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] | 1187 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 1188 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. |
| 1189 | "type": "A String", # type is used to communicate the status of the reconciliation process. |
| 1190 | # See also: |
| 1191 | # https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting |
| 1192 | # Types common to all resources include: |
| 1193 | # * "Ready": True when the Resource is ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1194 | }, |
| 1195 | ], |
| 1196 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the CloudPubSubSource that |
| 1197 | # was last processed by the controller. |
| 1198 | "sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the |
| 1199 | # Source. |
| 1200 | # +optional |
| 1201 | }, |
| 1202 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| 1203 | "spec": { # The desired state of the CloudPubSubSource. # Spec defines the desired state of the CloudPubSubSource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1204 | "pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create |
| 1205 | # Topic / PullSubscription resources. If omitted, uses Secret. |
| 1206 | # |
| 1207 | # Cloud Run on GKE: supported |
| 1208 | # |
| 1209 | # SecretKeySelector selects a key of a Secret. |
| 1210 | "optional": True or False, # Cloud Run fully managed: not supported |
| 1211 | # |
| 1212 | # Cloud Run on GKE: supported |
| 1213 | # |
| 1214 | # Specify whether the Secret or its key must be defined |
| 1215 | # +optional |
| 1216 | "key": "A String", # Cloud Run fully managed: not supported |
| 1217 | # |
| 1218 | # Cloud Run on GKE: supported |
| 1219 | # |
| 1220 | # The key of the secret to select from. Must be a valid secret key. |
| 1221 | "name": "A String", # Cloud Run fully managed: not supported |
| 1222 | # |
| 1223 | # Cloud Run on GKE: supported |
| 1224 | # |
| 1225 | # The name of the secret in the pod's namespace to select from. |
| 1226 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 1227 | # directly into the message. Use the "name" field instead. |
| 1228 | # referenced object inside the same namespace. |
| 1229 | "name": "A String", # Name of the referent. |
| 1230 | # More info: |
| 1231 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1232 | }, |
| 1233 | }, |
| 1234 | "sink": { # Sink is a reference to an object that will resolve to a domain name or a |
| 1235 | # URI directly to use as the sink. |
| 1236 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 1237 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 1238 | # appended to the path of the resulting URL from the Addressable. |
| 1239 | # + optional |
| 1240 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 1241 | # + optional |
| 1242 | # referred object. |
| 1243 | "apiVersion": "A String", # API version of the referent. |
| 1244 | # +optional |
| 1245 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 1246 | # More info: |
| 1247 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1248 | # +optional |
| 1249 | "name": "A String", # Name of the referent. |
| 1250 | # More info: |
| 1251 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1252 | # +optional |
| 1253 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 1254 | # string should contain a valid JSON/Go field access statement, such as |
| 1255 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 1256 | # is to a container within a pod, this would take on a value like: |
| 1257 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 1258 | # that triggered the event) or if no container name is specified |
| 1259 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 1260 | # chosen only to have some well-defined way of referencing a part of an |
| 1261 | # object. |
| 1262 | "uid": "A String", # UID of the referent. |
| 1263 | # More info: |
| 1264 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 1265 | # +optional |
| 1266 | "namespace": "A String", # Namespace of the referent. |
| 1267 | # More info: |
| 1268 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 1269 | # +optional |
| 1270 | "kind": "A String", # Kind of the referent. |
| 1271 | # More info: |
| 1272 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1273 | # +optional |
| 1274 | }, |
| 1275 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1276 | "retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If |
| 1277 | # true, acknowledged messages will not be expunged until they fall out of |
| 1278 | # the RetentionDuration window. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1279 | "ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a |
| 1280 | # message before the subscriber should acknowledge the message. Defaults |
| 1281 | # to 30 seconds ('30s'). |
| 1282 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1283 | "retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from |
| 1284 | # the time of publish. If RetainAckedMessages is true, this duration |
| 1285 | # affects the retention of acknowledged messages, otherwise only |
| 1286 | # unacknowledged messages are retained. Cannot be longer than 7 days or |
| 1287 | # shorter than 10 minutes. Defaults to 7 days ('7d'). |
| 1288 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1289 | "ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and |
| 1290 | # modifications of the event sent to the sink. |
| 1291 | # +optional |
| 1292 | # format of the CloudEvents produced by the Source. |
| 1293 | "extensions": { # Extensions specify what attribute are added or overridden on the outbound |
| 1294 | # event. Each `Extensions` key-value pair are set on the event as an |
| 1295 | # attribute extension independently. |
| 1296 | # +optional |
| 1297 | "a_key": "A String", |
| 1298 | }, |
| 1299 | }, |
| 1300 | "secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job. |
| 1301 | # If not specified, defaults to: |
| 1302 | # Name: google-cloud-key |
| 1303 | # Key: key.json |
| 1304 | # +optional |
| 1305 | # |
| 1306 | # Cloud Run on GKE: supported |
| 1307 | # |
| 1308 | # SecretKeySelector selects a key of a Secret. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1309 | "optional": True or False, # Cloud Run fully managed: not supported |
| 1310 | # |
| 1311 | # Cloud Run on GKE: supported |
| 1312 | # |
| 1313 | # Specify whether the Secret or its key must be defined |
| 1314 | # +optional |
| 1315 | "key": "A String", # Cloud Run fully managed: not supported |
| 1316 | # |
| 1317 | # Cloud Run on GKE: supported |
| 1318 | # |
| 1319 | # The key of the secret to select from. Must be a valid secret key. |
| 1320 | "name": "A String", # Cloud Run fully managed: not supported |
| 1321 | # |
| 1322 | # Cloud Run on GKE: supported |
| 1323 | # |
| 1324 | # 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] | 1325 | "localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined |
| 1326 | # directly into the message. Use the "name" field instead. |
| 1327 | # referenced object inside the same namespace. |
| 1328 | "name": "A String", # Name of the referent. |
| 1329 | # More info: |
| 1330 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 1331 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1332 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1333 | "topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must |
| 1334 | # be in the form of the unique identifier within the project, not the |
| 1335 | # entire name. E.g. it must be 'laconia', not |
| 1336 | # 'projects/my-proj/topics/laconia'. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1337 | "project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource |
| 1338 | # Topic exists in. If omitted, defaults to same as the cluster. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1339 | }, |
| 1340 | "kind": "A String", # The kind of resource, in this case "CloudPubSubSource". |
| 1341 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this CloudPubSubSource. |
| 1342 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1343 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 1344 | # |
| 1345 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1346 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1347 | # used, the name returned to the client will be different than the name |
| 1348 | # passed. This value will also be combined with a unique suffix. The provided |
| 1349 | # value has the same validation rules as the Name field, and may be truncated |
| 1350 | # by the length of the suffix required to make the value unique on the |
| 1351 | # server. |
| 1352 | # |
| 1353 | # If this field is specified and the generated name exists, the server will |
| 1354 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1355 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1356 | # time allotted, and the client should retry (optionally after the time |
| 1357 | # indicated in the Retry-After header). |
| 1358 | # |
| 1359 | # Applied only if Name is not specified. |
| 1360 | # More info: |
| 1361 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1362 | # +optional |
| 1363 | # string generateName = 2; |
| 1364 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1365 | # Is required when creating |
| 1366 | # resources, although some resources may allow a client to request the |
| 1367 | # generation of an appropriate name automatically. Name is primarily intended |
| 1368 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1369 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1370 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1371 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 1372 | # |
| 1373 | # Number of seconds allowed for this object to gracefully terminate before |
| 1374 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1375 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1376 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 1377 | # |
| 1378 | # The name of the cluster which the object belongs to. |
| 1379 | # This is used to distinguish resources with same name and namespace in |
| 1380 | # different clusters. This field is not set anywhere right now and apiserver |
| 1381 | # 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] | 1382 | "finalizers": [ # Not currently supported by Cloud Run. |
| 1383 | # |
| 1384 | # Must be empty before the object is deleted from the registry. Each entry |
| 1385 | # is an identifier for the responsible component that will remove the entry |
| 1386 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1387 | # in this list can only be removed. |
| 1388 | # +optional |
| 1389 | # +patchStrategy=merge |
| 1390 | "A String", |
| 1391 | ], |
| 1392 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1393 | # deleted. This field is set by the server when a graceful deletion is |
| 1394 | # requested by the user, and is not directly settable by a client. The |
| 1395 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1396 | # and not reachable by name) after the time in this field, once the |
| 1397 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1398 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1399 | # be unset or be set further into the future, although it may be shortened or |
| 1400 | # the resource may be deleted prior to this time. For example, a user may |
| 1401 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1402 | # sending a graceful termination signal to the containers in the pod. After |
| 1403 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1404 | # to the container and after cleanup, remove the pod from the API. In the |
| 1405 | # presence of network partitions, this object may still exist after this |
| 1406 | # timestamp, until an administrator or automated process can determine the |
| 1407 | # resource is fully terminated. |
| 1408 | # If not set, graceful deletion of the object has not been requested. |
| 1409 | # |
| 1410 | # Populated by the system when a graceful deletion is requested. |
| 1411 | # Read-only. |
| 1412 | # More info: |
| 1413 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1414 | # +optional |
| 1415 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 1416 | # been deleted, this object will be garbage collected. |
| 1417 | # +optional |
| 1418 | { # OwnerReference contains enough information to let you identify an owning |
| 1419 | # object. Currently, an owning object must be in the same namespace, so there |
| 1420 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1421 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1422 | # +optional |
| 1423 | "kind": "A String", # Kind of the referent. |
| 1424 | # More info: |
| 1425 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1426 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1427 | # the owner cannot be deleted from the key-value store until this |
| 1428 | # reference is removed. |
| 1429 | # Defaults to false. |
| 1430 | # To set this field, a user needs "delete" permission of the owner, |
| 1431 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1432 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1433 | "apiVersion": "A String", # API version of the referent. |
| 1434 | "name": "A String", # Name of the referent. |
| 1435 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1436 | "uid": "A String", # UID of the referent. |
| 1437 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1438 | }, |
| 1439 | ], |
| 1440 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 1441 | # object was created. It is not guaranteed to be set in happens-before order |
| 1442 | # across separate operations. Clients may not set this value. It is |
| 1443 | # represented in RFC3339 form and is in UTC. |
| 1444 | # |
| 1445 | # Populated by the system. |
| 1446 | # Read-only. |
| 1447 | # Null for lists. |
| 1448 | # More info: |
| 1449 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1450 | # +optional |
| 1451 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 1452 | # (scope and select) objects. May match selectors of replication controllers |
| 1453 | # and routes. |
| 1454 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1455 | # +optional |
| 1456 | "a_key": "A String", |
| 1457 | }, |
| 1458 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 1459 | # Populated by the system. Read-only. |
| 1460 | # +optional |
| 1461 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 1462 | # can be used by clients to determine when objects have changed. May be used |
| 1463 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1464 | # resource or set of resources. Clients must treat these values as opaque and |
| 1465 | # passed unmodified back to the server. They may only be valid for a |
| 1466 | # particular resource or set of resources. |
| 1467 | # |
| 1468 | # Populated by the system. |
| 1469 | # Read-only. |
| 1470 | # Value must be treated as opaque by clients and . |
| 1471 | # More info: |
| 1472 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1473 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1474 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 1475 | # Populated by the system. |
| 1476 | # Read-only. |
| 1477 | # +optional |
| 1478 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1479 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 1480 | # generated by the server on successful creation of a resource and is not |
| 1481 | # allowed to change on PUT operations. |
| 1482 | # |
| 1483 | # Populated by the system. |
| 1484 | # Read-only. |
| 1485 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1486 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1487 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1488 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1489 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1490 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 1491 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1492 | # are not queryable and should be preserved when modifying objects. More |
| 1493 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 1494 | "a_key": "A String", |
| 1495 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1496 | }, |
| 1497 | }, |
| 1498 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1499 | "apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1". |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1500 | }</pre> |
| 1501 | </div> |
| 1502 | |
| 1503 | </body></html> |