| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -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.triggers.html">triggers</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Creates a new trigger.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Rpc to delete a trigger.</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 trigger.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Rpc to list triggers.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 91 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | <pre>Creates a new trigger. |
| 93 | |
| 94 | Args: |
| 95 | parent: string, The project ID or project number in which this trigger should |
| 96 | be created. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 97 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | The object takes the form of: |
| 99 | |
| 100 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 101 | "status": { # TriggerStatus represents the current state of a Trigger. # Optional. Status represents the current state of the Trigger. This data may be out of |
| 102 | # date. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | "subscriberUri": "A String", # SubscriberURI is the resolved URI of the receiver for this Trigger. |
| 104 | "conditions": [ # Array of observed TriggerConditions, indicating the current state |
| 105 | # of the Trigger. |
| 106 | { # TriggerCondition contains state information for an Trigger. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 107 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 108 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 109 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 110 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 111 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's current status. |
| 112 | "type": "A String", # Type of Trigger condition. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 113 | }, |
| 114 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 115 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Trigger that |
| 116 | # was last processed by the controller. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 117 | }, |
| 118 | "apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1". |
| 119 | "spec": { # The desired state of the Trigger. # Spec defines the desired state of the Trigger. |
| 120 | "broker": "A String", # Broker is the broker that this trigger receives events from. If not |
| 121 | # specified, will default to 'default'. |
| 122 | # |
| 123 | # Not currently supported by Cloud Run. |
| 124 | "filter": { # Optional. Filter is the filter to apply against all events from the Broker. Only |
| 125 | # events that pass this filter will be sent to the Subscriber. |
| 126 | # Note that filter is optional in knative and is only required in fully |
| 127 | # managed due to different broker implementation. |
| 128 | "attributes": { # Optional. Attributes filters events by exact match on event context attributes. |
| 129 | # Each key in the map is compared with the equivalent key in the event |
| 130 | # context. An event passes the filter if all values are equal to the |
| 131 | # specified values. |
| 132 | # |
| 133 | # Nested context attributes are not supported as keys. |
| 134 | # Only string values are supported. |
| 135 | # Note that this field is optional in knative. In fully managed, 'type' |
| 136 | # attribute is required due to different broker implementation. |
| 137 | "a_key": "A String", |
| 138 | }, |
| 139 | }, |
| 140 | "subscriber": { # Sink is the addressable that will receive events. |
| 141 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 142 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 143 | # appended to the path of the resulting URL from the Addressable. |
| 144 | # + optional |
| 145 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 146 | # + optional |
| 147 | # referred object. |
| 148 | "apiVersion": "A String", # API version of the referent. |
| 149 | # +optional |
| 150 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 151 | # More info: |
| 152 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 153 | # +optional |
| 154 | "name": "A String", # Name of the referent. |
| 155 | # More info: |
| 156 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 157 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 159 | # string should contain a valid JSON/Go field access statement, such as |
| 160 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 161 | # is to a container within a pod, this would take on a value like: |
| 162 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 163 | # that triggered the event) or if no container name is specified |
| 164 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 165 | # chosen only to have some well-defined way of referencing a part of an |
| 166 | # object. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 167 | "uid": "A String", # UID of the referent. |
| 168 | # More info: |
| 169 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 170 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | "namespace": "A String", # Namespace of the referent. |
| 172 | # More info: |
| 173 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 174 | # +optional |
| 175 | "kind": "A String", # Kind of the referent. |
| 176 | # More info: |
| 177 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 178 | # +optional |
| 179 | }, |
| 180 | }, |
| 181 | }, |
| 182 | "kind": "A String", # The kind of resource, in this case "Trigger". |
| 183 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Trigger. |
| 184 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 185 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 186 | # |
| 187 | # GenerateName is an optional prefix, used by the server, to generate a |
| 188 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 189 | # used, the name returned to the client will be different than the name |
| 190 | # passed. This value will also be combined with a unique suffix. The provided |
| 191 | # value has the same validation rules as the Name field, and may be truncated |
| 192 | # by the length of the suffix required to make the value unique on the |
| 193 | # server. |
| 194 | # |
| 195 | # If this field is specified and the generated name exists, the server will |
| 196 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 197 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 198 | # time allotted, and the client should retry (optionally after the time |
| 199 | # indicated in the Retry-After header). |
| 200 | # |
| 201 | # Applied only if Name is not specified. |
| 202 | # More info: |
| 203 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 204 | # +optional |
| 205 | # string generateName = 2; |
| 206 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 207 | # Is required when creating |
| 208 | # resources, although some resources may allow a client to request the |
| 209 | # generation of an appropriate name automatically. Name is primarily intended |
| 210 | # for creation idempotence and configuration definition. Cannot be updated. |
| 211 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 212 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 213 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 214 | # |
| 215 | # Number of seconds allowed for this object to gracefully terminate before |
| 216 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 217 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 218 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 219 | # |
| 220 | # The name of the cluster which the object belongs to. |
| 221 | # This is used to distinguish resources with same name and namespace in |
| 222 | # different clusters. This field is not set anywhere right now and apiserver |
| 223 | # 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] | 224 | "finalizers": [ # Not currently supported by Cloud Run. |
| 225 | # |
| 226 | # Must be empty before the object is deleted from the registry. Each entry |
| 227 | # is an identifier for the responsible component that will remove the entry |
| 228 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 229 | # in this list can only be removed. |
| 230 | # +optional |
| 231 | # +patchStrategy=merge |
| 232 | "A String", |
| 233 | ], |
| 234 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 235 | # deleted. This field is set by the server when a graceful deletion is |
| 236 | # requested by the user, and is not directly settable by a client. The |
| 237 | # resource is expected to be deleted (no longer visible from resource lists, |
| 238 | # and not reachable by name) after the time in this field, once the |
| 239 | # finalizers list is empty. As long as the finalizers list contains items, |
| 240 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 241 | # be unset or be set further into the future, although it may be shortened or |
| 242 | # the resource may be deleted prior to this time. For example, a user may |
| 243 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 244 | # sending a graceful termination signal to the containers in the pod. After |
| 245 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 246 | # to the container and after cleanup, remove the pod from the API. In the |
| 247 | # presence of network partitions, this object may still exist after this |
| 248 | # timestamp, until an administrator or automated process can determine the |
| 249 | # resource is fully terminated. |
| 250 | # If not set, graceful deletion of the object has not been requested. |
| 251 | # |
| 252 | # Populated by the system when a graceful deletion is requested. |
| 253 | # Read-only. |
| 254 | # More info: |
| 255 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 256 | # +optional |
| 257 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 258 | # been deleted, this object will be garbage collected. |
| 259 | # +optional |
| 260 | { # OwnerReference contains enough information to let you identify an owning |
| 261 | # object. Currently, an owning object must be in the same namespace, so there |
| 262 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "controller": True or False, # If true, this reference points to the managing controller. |
| 264 | # +optional |
| 265 | "kind": "A String", # Kind of the referent. |
| 266 | # More info: |
| 267 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 268 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 269 | # the owner cannot be deleted from the key-value store until this |
| 270 | # reference is removed. |
| 271 | # Defaults to false. |
| 272 | # To set this field, a user needs "delete" permission of the owner, |
| 273 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 274 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 275 | "apiVersion": "A String", # API version of the referent. |
| 276 | "name": "A String", # Name of the referent. |
| 277 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 278 | "uid": "A String", # UID of the referent. |
| 279 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 280 | }, |
| 281 | ], |
| 282 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 283 | # object was created. It is not guaranteed to be set in happens-before order |
| 284 | # across separate operations. Clients may not set this value. It is |
| 285 | # represented in RFC3339 form and is in UTC. |
| 286 | # |
| 287 | # Populated by the system. |
| 288 | # Read-only. |
| 289 | # Null for lists. |
| 290 | # More info: |
| 291 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 292 | # +optional |
| 293 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 294 | # (scope and select) objects. May match selectors of replication controllers |
| 295 | # and routes. |
| 296 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 297 | # +optional |
| 298 | "a_key": "A String", |
| 299 | }, |
| 300 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 301 | # Populated by the system. Read-only. |
| 302 | # +optional |
| 303 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 304 | # can be used by clients to determine when objects have changed. May be used |
| 305 | # for optimistic concurrency, change detection, and the watch operation on a |
| 306 | # resource or set of resources. Clients must treat these values as opaque and |
| 307 | # passed unmodified back to the server. They may only be valid for a |
| 308 | # particular resource or set of resources. |
| 309 | # |
| 310 | # Populated by the system. |
| 311 | # Read-only. |
| 312 | # Value must be treated as opaque by clients and . |
| 313 | # More info: |
| 314 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 315 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 316 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 317 | # Populated by the system. |
| 318 | # Read-only. |
| 319 | # +optional |
| 320 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 321 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 322 | # generated by the server on successful creation of a resource and is not |
| 323 | # allowed to change on PUT operations. |
| 324 | # |
| 325 | # Populated by the system. |
| 326 | # Read-only. |
| 327 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 328 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 329 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 330 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 331 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 332 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 333 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 334 | # are not queryable and should be preserved when modifying objects. More |
| 335 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 336 | "a_key": "A String", |
| 337 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | }, |
| 339 | } |
| 340 | |
| 341 | x__xgafv: string, V1 error format. |
| 342 | Allowed values |
| 343 | 1 - v1 error format |
| 344 | 2 - v2 error format |
| 345 | |
| 346 | Returns: |
| 347 | An object of the form: |
| 348 | |
| 349 | { |
| 350 | "status": { # TriggerStatus represents the current state of a Trigger. # Optional. Status represents the current state of the Trigger. This data may be out of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 351 | # date. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 352 | "subscriberUri": "A String", # SubscriberURI is the resolved URI of the receiver for this Trigger. |
| 353 | "conditions": [ # Array of observed TriggerConditions, indicating the current state |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 354 | # of the Trigger. |
| 355 | { # TriggerCondition contains state information for an Trigger. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 356 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 357 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 359 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 360 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's current status. |
| 361 | "type": "A String", # Type of Trigger condition. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 362 | }, |
| 363 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 364 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Trigger that |
| 365 | # was last processed by the controller. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 366 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 367 | "apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1". |
| 368 | "spec": { # The desired state of the Trigger. # Spec defines the desired state of the Trigger. |
| 369 | "broker": "A String", # Broker is the broker that this trigger receives events from. If not |
| 370 | # specified, will default to 'default'. |
| 371 | # |
| 372 | # Not currently supported by Cloud Run. |
| 373 | "filter": { # Optional. Filter is the filter to apply against all events from the Broker. Only |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 374 | # events that pass this filter will be sent to the Subscriber. |
| 375 | # Note that filter is optional in knative and is only required in fully |
| 376 | # managed due to different broker implementation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 377 | "attributes": { # Optional. Attributes filters events by exact match on event context attributes. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 378 | # Each key in the map is compared with the equivalent key in the event |
| 379 | # context. An event passes the filter if all values are equal to the |
| 380 | # specified values. |
| 381 | # |
| 382 | # Nested context attributes are not supported as keys. |
| 383 | # Only string values are supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 384 | # Note that this field is optional in knative. In fully managed, 'type' |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 385 | # attribute is required due to different broker implementation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 386 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 387 | }, |
| 388 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 389 | "subscriber": { # Sink is the addressable that will receive events. |
| 390 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 391 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 392 | # appended to the path of the resulting URL from the Addressable. |
| 393 | # + optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 394 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 395 | # + optional |
| 396 | # referred object. |
| 397 | "apiVersion": "A String", # API version of the referent. |
| 398 | # +optional |
| 399 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 400 | # More info: |
| 401 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 402 | # +optional |
| 403 | "name": "A String", # Name of the referent. |
| 404 | # More info: |
| 405 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 406 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 407 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 408 | # string should contain a valid JSON/Go field access statement, such as |
| 409 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 410 | # is to a container within a pod, this would take on a value like: |
| 411 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 412 | # that triggered the event) or if no container name is specified |
| 413 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 414 | # chosen only to have some well-defined way of referencing a part of an |
| 415 | # object. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 416 | "uid": "A String", # UID of the referent. |
| 417 | # More info: |
| 418 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 419 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 420 | "namespace": "A String", # Namespace of the referent. |
| 421 | # More info: |
| 422 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 423 | # +optional |
| 424 | "kind": "A String", # Kind of the referent. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 425 | # More info: |
| 426 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 427 | # +optional |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 428 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 429 | }, |
| 430 | }, |
| 431 | "kind": "A String", # The kind of resource, in this case "Trigger". |
| 432 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Trigger. |
| 433 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 434 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 435 | # |
| 436 | # GenerateName is an optional prefix, used by the server, to generate a |
| 437 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 438 | # used, the name returned to the client will be different than the name |
| 439 | # passed. This value will also be combined with a unique suffix. The provided |
| 440 | # value has the same validation rules as the Name field, and may be truncated |
| 441 | # by the length of the suffix required to make the value unique on the |
| 442 | # server. |
| 443 | # |
| 444 | # If this field is specified and the generated name exists, the server will |
| 445 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 446 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 447 | # time allotted, and the client should retry (optionally after the time |
| 448 | # indicated in the Retry-After header). |
| 449 | # |
| 450 | # Applied only if Name is not specified. |
| 451 | # More info: |
| 452 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 453 | # +optional |
| 454 | # string generateName = 2; |
| 455 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 456 | # Is required when creating |
| 457 | # resources, although some resources may allow a client to request the |
| 458 | # generation of an appropriate name automatically. Name is primarily intended |
| 459 | # for creation idempotence and configuration definition. Cannot be updated. |
| 460 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 461 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 462 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 463 | # |
| 464 | # Number of seconds allowed for this object to gracefully terminate before |
| 465 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 466 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 467 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 468 | # |
| 469 | # The name of the cluster which the object belongs to. |
| 470 | # This is used to distinguish resources with same name and namespace in |
| 471 | # different clusters. This field is not set anywhere right now and apiserver |
| 472 | # 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] | 473 | "finalizers": [ # Not currently supported by Cloud Run. |
| 474 | # |
| 475 | # Must be empty before the object is deleted from the registry. Each entry |
| 476 | # is an identifier for the responsible component that will remove the entry |
| 477 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 478 | # in this list can only be removed. |
| 479 | # +optional |
| 480 | # +patchStrategy=merge |
| 481 | "A String", |
| 482 | ], |
| 483 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 484 | # deleted. This field is set by the server when a graceful deletion is |
| 485 | # requested by the user, and is not directly settable by a client. The |
| 486 | # resource is expected to be deleted (no longer visible from resource lists, |
| 487 | # and not reachable by name) after the time in this field, once the |
| 488 | # finalizers list is empty. As long as the finalizers list contains items, |
| 489 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 490 | # be unset or be set further into the future, although it may be shortened or |
| 491 | # the resource may be deleted prior to this time. For example, a user may |
| 492 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 493 | # sending a graceful termination signal to the containers in the pod. After |
| 494 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 495 | # to the container and after cleanup, remove the pod from the API. In the |
| 496 | # presence of network partitions, this object may still exist after this |
| 497 | # timestamp, until an administrator or automated process can determine the |
| 498 | # resource is fully terminated. |
| 499 | # If not set, graceful deletion of the object has not been requested. |
| 500 | # |
| 501 | # Populated by the system when a graceful deletion is requested. |
| 502 | # Read-only. |
| 503 | # More info: |
| 504 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 505 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 506 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 507 | # been deleted, this object will be garbage collected. |
| 508 | # +optional |
| 509 | { # OwnerReference contains enough information to let you identify an owning |
| 510 | # object. Currently, an owning object must be in the same namespace, so there |
| 511 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 512 | "controller": True or False, # If true, this reference points to the managing controller. |
| 513 | # +optional |
| 514 | "kind": "A String", # Kind of the referent. |
| 515 | # More info: |
| 516 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 517 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 518 | # the owner cannot be deleted from the key-value store until this |
| 519 | # reference is removed. |
| 520 | # Defaults to false. |
| 521 | # To set this field, a user needs "delete" permission of the owner, |
| 522 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 523 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 524 | "apiVersion": "A String", # API version of the referent. |
| 525 | "name": "A String", # Name of the referent. |
| 526 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 527 | "uid": "A String", # UID of the referent. |
| 528 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 529 | }, |
| 530 | ], |
| 531 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 532 | # object was created. It is not guaranteed to be set in happens-before order |
| 533 | # across separate operations. Clients may not set this value. It is |
| 534 | # represented in RFC3339 form and is in UTC. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 535 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 536 | # Populated by the system. |
| 537 | # Read-only. |
| 538 | # Null for lists. |
| 539 | # More info: |
| 540 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 541 | # +optional |
| 542 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 543 | # (scope and select) objects. May match selectors of replication controllers |
| 544 | # and routes. |
| 545 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 546 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 547 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 548 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 549 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 550 | # Populated by the system. Read-only. |
| 551 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 552 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 553 | # can be used by clients to determine when objects have changed. May be used |
| 554 | # for optimistic concurrency, change detection, and the watch operation on a |
| 555 | # resource or set of resources. Clients must treat these values as opaque and |
| 556 | # passed unmodified back to the server. They may only be valid for a |
| 557 | # particular resource or set of resources. |
| 558 | # |
| 559 | # Populated by the system. |
| 560 | # Read-only. |
| 561 | # Value must be treated as opaque by clients and . |
| 562 | # More info: |
| 563 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 564 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 565 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 566 | # Populated by the system. |
| 567 | # Read-only. |
| 568 | # +optional |
| 569 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 570 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 571 | # generated by the server on successful creation of a resource and is not |
| 572 | # allowed to change on PUT operations. |
| 573 | # |
| 574 | # Populated by the system. |
| 575 | # Read-only. |
| 576 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 577 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 578 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 579 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 580 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 581 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 582 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 583 | # are not queryable and should be preserved when modifying objects. More |
| 584 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 585 | "a_key": "A String", |
| 586 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 587 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 588 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 589 | </div> |
| 590 | |
| 591 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 592 | <code class="details" id="delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 593 | <pre>Rpc to delete a trigger. |
| 594 | |
| 595 | Args: |
| 596 | name: string, The name of the trigger being deleted. If needed, replace |
| 597 | {namespace_id} with the project ID. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 598 | apiVersion: string, Cloud Run currently ignores this parameter. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 599 | propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores |
| 600 | this setting, and deletes in the background. Please see |
| 601 | kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for |
| 602 | more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 603 | kind: string, Cloud Run currently ignores this parameter. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 604 | x__xgafv: string, V1 error format. |
| 605 | Allowed values |
| 606 | 1 - v1 error format |
| 607 | 2 - v2 error format |
| 608 | |
| 609 | Returns: |
| 610 | An object of the form: |
| 611 | |
| 612 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 613 | # empty messages in your APIs. A typical example is to use it as the request |
| 614 | # or the response type of an API method. For instance: |
| 615 | # |
| 616 | # service Foo { |
| 617 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 618 | # } |
| 619 | # |
| 620 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 621 | }</pre> |
| 622 | </div> |
| 623 | |
| 624 | <div class="method"> |
| 625 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 626 | <pre>Rpc to get information about a trigger. |
| 627 | |
| 628 | Args: |
| 629 | name: string, The name of the trigger being retrieved. If needed, replace |
| 630 | {namespace_id} with the project ID. (required) |
| 631 | x__xgafv: string, V1 error format. |
| 632 | Allowed values |
| 633 | 1 - v1 error format |
| 634 | 2 - v2 error format |
| 635 | |
| 636 | Returns: |
| 637 | An object of the form: |
| 638 | |
| 639 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 640 | "status": { # TriggerStatus represents the current state of a Trigger. # Optional. Status represents the current state of the Trigger. This data may be out of |
| 641 | # date. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 642 | "subscriberUri": "A String", # SubscriberURI is the resolved URI of the receiver for this Trigger. |
| 643 | "conditions": [ # Array of observed TriggerConditions, indicating the current state |
| 644 | # of the Trigger. |
| 645 | { # TriggerCondition contains state information for an Trigger. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 646 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 647 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 648 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 649 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 650 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's current status. |
| 651 | "type": "A String", # Type of Trigger condition. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 652 | }, |
| 653 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 654 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Trigger that |
| 655 | # was last processed by the controller. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 656 | }, |
| 657 | "apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1". |
| 658 | "spec": { # The desired state of the Trigger. # Spec defines the desired state of the Trigger. |
| 659 | "broker": "A String", # Broker is the broker that this trigger receives events from. If not |
| 660 | # specified, will default to 'default'. |
| 661 | # |
| 662 | # Not currently supported by Cloud Run. |
| 663 | "filter": { # Optional. Filter is the filter to apply against all events from the Broker. Only |
| 664 | # events that pass this filter will be sent to the Subscriber. |
| 665 | # Note that filter is optional in knative and is only required in fully |
| 666 | # managed due to different broker implementation. |
| 667 | "attributes": { # Optional. Attributes filters events by exact match on event context attributes. |
| 668 | # Each key in the map is compared with the equivalent key in the event |
| 669 | # context. An event passes the filter if all values are equal to the |
| 670 | # specified values. |
| 671 | # |
| 672 | # Nested context attributes are not supported as keys. |
| 673 | # Only string values are supported. |
| 674 | # Note that this field is optional in knative. In fully managed, 'type' |
| 675 | # attribute is required due to different broker implementation. |
| 676 | "a_key": "A String", |
| 677 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 678 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 679 | "subscriber": { # Sink is the addressable that will receive events. |
| 680 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 681 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 682 | # appended to the path of the resulting URL from the Addressable. |
| 683 | # + optional |
| 684 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 685 | # + optional |
| 686 | # referred object. |
| 687 | "apiVersion": "A String", # API version of the referent. |
| 688 | # +optional |
| 689 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 690 | # More info: |
| 691 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 692 | # +optional |
| 693 | "name": "A String", # Name of the referent. |
| 694 | # More info: |
| 695 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 696 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 697 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 698 | # string should contain a valid JSON/Go field access statement, such as |
| 699 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 700 | # is to a container within a pod, this would take on a value like: |
| 701 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 702 | # that triggered the event) or if no container name is specified |
| 703 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 704 | # chosen only to have some well-defined way of referencing a part of an |
| 705 | # object. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 706 | "uid": "A String", # UID of the referent. |
| 707 | # More info: |
| 708 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 709 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 710 | "namespace": "A String", # Namespace of the referent. |
| 711 | # More info: |
| 712 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 713 | # +optional |
| 714 | "kind": "A String", # Kind of the referent. |
| 715 | # More info: |
| 716 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 717 | # +optional |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 718 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 719 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 720 | }, |
| 721 | "kind": "A String", # The kind of resource, in this case "Trigger". |
| 722 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Trigger. |
| 723 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 724 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 725 | # |
| 726 | # GenerateName is an optional prefix, used by the server, to generate a |
| 727 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 728 | # used, the name returned to the client will be different than the name |
| 729 | # passed. This value will also be combined with a unique suffix. The provided |
| 730 | # value has the same validation rules as the Name field, and may be truncated |
| 731 | # by the length of the suffix required to make the value unique on the |
| 732 | # server. |
| 733 | # |
| 734 | # If this field is specified and the generated name exists, the server will |
| 735 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 736 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 737 | # time allotted, and the client should retry (optionally after the time |
| 738 | # indicated in the Retry-After header). |
| 739 | # |
| 740 | # Applied only if Name is not specified. |
| 741 | # More info: |
| 742 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 743 | # +optional |
| 744 | # string generateName = 2; |
| 745 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 746 | # Is required when creating |
| 747 | # resources, although some resources may allow a client to request the |
| 748 | # generation of an appropriate name automatically. Name is primarily intended |
| 749 | # for creation idempotence and configuration definition. Cannot be updated. |
| 750 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 751 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 752 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 753 | # |
| 754 | # Number of seconds allowed for this object to gracefully terminate before |
| 755 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 756 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 757 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 758 | # |
| 759 | # The name of the cluster which the object belongs to. |
| 760 | # This is used to distinguish resources with same name and namespace in |
| 761 | # different clusters. This field is not set anywhere right now and apiserver |
| 762 | # 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] | 763 | "finalizers": [ # Not currently supported by Cloud Run. |
| 764 | # |
| 765 | # Must be empty before the object is deleted from the registry. Each entry |
| 766 | # is an identifier for the responsible component that will remove the entry |
| 767 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 768 | # in this list can only be removed. |
| 769 | # +optional |
| 770 | # +patchStrategy=merge |
| 771 | "A String", |
| 772 | ], |
| 773 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 774 | # deleted. This field is set by the server when a graceful deletion is |
| 775 | # requested by the user, and is not directly settable by a client. The |
| 776 | # resource is expected to be deleted (no longer visible from resource lists, |
| 777 | # and not reachable by name) after the time in this field, once the |
| 778 | # finalizers list is empty. As long as the finalizers list contains items, |
| 779 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 780 | # be unset or be set further into the future, although it may be shortened or |
| 781 | # the resource may be deleted prior to this time. For example, a user may |
| 782 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 783 | # sending a graceful termination signal to the containers in the pod. After |
| 784 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 785 | # to the container and after cleanup, remove the pod from the API. In the |
| 786 | # presence of network partitions, this object may still exist after this |
| 787 | # timestamp, until an administrator or automated process can determine the |
| 788 | # resource is fully terminated. |
| 789 | # If not set, graceful deletion of the object has not been requested. |
| 790 | # |
| 791 | # Populated by the system when a graceful deletion is requested. |
| 792 | # Read-only. |
| 793 | # More info: |
| 794 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 795 | # +optional |
| 796 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 797 | # been deleted, this object will be garbage collected. |
| 798 | # +optional |
| 799 | { # OwnerReference contains enough information to let you identify an owning |
| 800 | # object. Currently, an owning object must be in the same namespace, so there |
| 801 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 802 | "controller": True or False, # If true, this reference points to the managing controller. |
| 803 | # +optional |
| 804 | "kind": "A String", # Kind of the referent. |
| 805 | # More info: |
| 806 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 807 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 808 | # the owner cannot be deleted from the key-value store until this |
| 809 | # reference is removed. |
| 810 | # Defaults to false. |
| 811 | # To set this field, a user needs "delete" permission of the owner, |
| 812 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 813 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 814 | "apiVersion": "A String", # API version of the referent. |
| 815 | "name": "A String", # Name of the referent. |
| 816 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 817 | "uid": "A String", # UID of the referent. |
| 818 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 819 | }, |
| 820 | ], |
| 821 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 822 | # object was created. It is not guaranteed to be set in happens-before order |
| 823 | # across separate operations. Clients may not set this value. It is |
| 824 | # represented in RFC3339 form and is in UTC. |
| 825 | # |
| 826 | # Populated by the system. |
| 827 | # Read-only. |
| 828 | # Null for lists. |
| 829 | # More info: |
| 830 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 831 | # +optional |
| 832 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 833 | # (scope and select) objects. May match selectors of replication controllers |
| 834 | # and routes. |
| 835 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 836 | # +optional |
| 837 | "a_key": "A String", |
| 838 | }, |
| 839 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 840 | # Populated by the system. Read-only. |
| 841 | # +optional |
| 842 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 843 | # can be used by clients to determine when objects have changed. May be used |
| 844 | # for optimistic concurrency, change detection, and the watch operation on a |
| 845 | # resource or set of resources. Clients must treat these values as opaque and |
| 846 | # passed unmodified back to the server. They may only be valid for a |
| 847 | # particular resource or set of resources. |
| 848 | # |
| 849 | # Populated by the system. |
| 850 | # Read-only. |
| 851 | # Value must be treated as opaque by clients and . |
| 852 | # More info: |
| 853 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 854 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 855 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 856 | # Populated by the system. |
| 857 | # Read-only. |
| 858 | # +optional |
| 859 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 860 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 861 | # generated by the server on successful creation of a resource and is not |
| 862 | # allowed to change on PUT operations. |
| 863 | # |
| 864 | # Populated by the system. |
| 865 | # Read-only. |
| 866 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 867 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 868 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 869 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 870 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 871 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 872 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 873 | # are not queryable and should be preserved when modifying objects. More |
| 874 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 875 | "a_key": "A String", |
| 876 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 877 | }, |
| 878 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 879 | </div> |
| 880 | |
| 881 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 882 | <code class="details" id="list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 883 | <pre>Rpc to list triggers. |
| 884 | |
| 885 | Args: |
| 886 | parent: string, The project ID or project number from which the triggers should |
| 887 | be listed. (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 888 | continue: string, Optional. Encoded string to continue paging. |
| 889 | limit: integer, The maximum number of records that should be returned. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 890 | watch: boolean, Flag that indicates that the client expects to watch this resource as well. |
| 891 | Not currently used by Cloud Run. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 892 | labelSelector: string, Allows to filter resources based on a label. Supported operations are |
| 893 | =, !=, exists, in, and notIn. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 894 | resourceVersion: string, The baseline resource version from which the list or watch operation should |
| 895 | start. Not currently used by Cloud Run. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 896 | includeUninitialized: boolean, Not currently used by Cloud Run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 897 | fieldSelector: string, Allows to filter resources based on a specific value for a field name. |
| 898 | Send this in a query string format. i.e. 'metadata.name%3Dlorem'. |
| 899 | Not currently used by Cloud Run. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 900 | x__xgafv: string, V1 error format. |
| 901 | Allowed values |
| 902 | 1 - v1 error format |
| 903 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 904 | |
| 905 | Returns: |
| 906 | An object of the form: |
| 907 | |
| 908 | { # ListTriggersResponse is a list of Trigger resources. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 909 | "kind": "A String", # The kind of this resource, in this case "TriggerList". |
| 910 | "unreachable": [ # Locations that could not be reached. |
| 911 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 912 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 913 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this Trigger list. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 914 | # lists and various status objects. A resource may have only one of |
| 915 | # {ObjectMeta, ListMeta}. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 916 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 917 | # can be used by clients to determine when objects have changed. Value must |
| 918 | # be treated as opaque by clients and passed unmodified back to the server. |
| 919 | # Populated by the system. |
| 920 | # Read-only. |
| 921 | # More info: |
| 922 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 923 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 924 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 925 | # returned, and indicates that the server has more data available. The value |
| 926 | # is opaque and may be used to issue another request to the endpoint that |
| 927 | # served this list to retrieve the next set of available objects. Continuing |
| 928 | # a list may not be possible if the server configuration has changed or more |
| 929 | # than a few minutes have passed. The resourceVersion field returned when |
| 930 | # using this continue value will be identical to the value in the first |
| 931 | # response. |
| 932 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 933 | # Populated by the system. |
| 934 | # Read-only. |
| 935 | # +optional |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 936 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 937 | "items": [ # List of Triggers. |
| 938 | { |
| 939 | "status": { # TriggerStatus represents the current state of a Trigger. # Optional. Status represents the current state of the Trigger. This data may be out of |
| 940 | # date. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 941 | "subscriberUri": "A String", # SubscriberURI is the resolved URI of the receiver for this Trigger. |
| 942 | "conditions": [ # Array of observed TriggerConditions, indicating the current state |
| 943 | # of the Trigger. |
| 944 | { # TriggerCondition contains state information for an Trigger. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 945 | "message": "A String", # Optional. Human readable message indicating details about the current status. |
| 946 | "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 947 | "status": "A String", # Status of the condition, one of True, False, Unknown. |
| 948 | "severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info |
| 949 | "reason": "A String", # Optional. One-word CamelCase reason for the condition's current status. |
| 950 | "type": "A String", # Type of Trigger condition. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 951 | }, |
| 952 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 953 | "observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Trigger that |
| 954 | # was last processed by the controller. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 955 | }, |
| 956 | "apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1". |
| 957 | "spec": { # The desired state of the Trigger. # Spec defines the desired state of the Trigger. |
| 958 | "broker": "A String", # Broker is the broker that this trigger receives events from. If not |
| 959 | # specified, will default to 'default'. |
| 960 | # |
| 961 | # Not currently supported by Cloud Run. |
| 962 | "filter": { # Optional. Filter is the filter to apply against all events from the Broker. Only |
| 963 | # events that pass this filter will be sent to the Subscriber. |
| 964 | # Note that filter is optional in knative and is only required in fully |
| 965 | # managed due to different broker implementation. |
| 966 | "attributes": { # Optional. Attributes filters events by exact match on event context attributes. |
| 967 | # Each key in the map is compared with the equivalent key in the event |
| 968 | # context. An event passes the filter if all values are equal to the |
| 969 | # specified values. |
| 970 | # |
| 971 | # Nested context attributes are not supported as keys. |
| 972 | # Only string values are supported. |
| 973 | # Note that this field is optional in knative. In fully managed, 'type' |
| 974 | # attribute is required due to different broker implementation. |
| 975 | "a_key": "A String", |
| 976 | }, |
| 977 | }, |
| 978 | "subscriber": { # Sink is the addressable that will receive events. |
| 979 | "uri": "A String", # URI is for direct URI Designations or used with the resulting URL from |
| 980 | # Addressable ObjectReference. If used with an ObjectReference, will be |
| 981 | # appended to the path of the resulting URL from the Addressable. |
| 982 | # + optional |
| 983 | "ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable. |
| 984 | # + optional |
| 985 | # referred object. |
| 986 | "apiVersion": "A String", # API version of the referent. |
| 987 | # +optional |
| 988 | "resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any. |
| 989 | # More info: |
| 990 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 991 | # +optional |
| 992 | "name": "A String", # Name of the referent. |
| 993 | # More info: |
| 994 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 995 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 996 | "fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this |
| 997 | # string should contain a valid JSON/Go field access statement, such as |
| 998 | # desiredState.manifest.containers[2]. For example, if the object reference |
| 999 | # is to a container within a pod, this would take on a value like: |
| 1000 | # "spec.containers{name}" (where "name" refers to the name of the container |
| 1001 | # that triggered the event) or if no container name is specified |
| 1002 | # "spec.containers[2]" (container with index 2 in this pod). This syntax is |
| 1003 | # chosen only to have some well-defined way of referencing a part of an |
| 1004 | # object. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1005 | "uid": "A String", # UID of the referent. |
| 1006 | # More info: |
| 1007 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| 1008 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1009 | "namespace": "A String", # Namespace of the referent. |
| 1010 | # More info: |
| 1011 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
| 1012 | # +optional |
| 1013 | "kind": "A String", # Kind of the referent. |
| 1014 | # More info: |
| 1015 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1016 | # +optional |
| 1017 | }, |
| 1018 | }, |
| 1019 | }, |
| 1020 | "kind": "A String", # The kind of resource, in this case "Trigger". |
| 1021 | "metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Trigger. |
| 1022 | # all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1023 | "generateName": "A String", # Not currently supported by Cloud Run. |
| 1024 | # |
| 1025 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1026 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1027 | # used, the name returned to the client will be different than the name |
| 1028 | # passed. This value will also be combined with a unique suffix. The provided |
| 1029 | # value has the same validation rules as the Name field, and may be truncated |
| 1030 | # by the length of the suffix required to make the value unique on the |
| 1031 | # server. |
| 1032 | # |
| 1033 | # If this field is specified and the generated name exists, the server will |
| 1034 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1035 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1036 | # time allotted, and the client should retry (optionally after the time |
| 1037 | # indicated in the Retry-After header). |
| 1038 | # |
| 1039 | # Applied only if Name is not specified. |
| 1040 | # More info: |
| 1041 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1042 | # +optional |
| 1043 | # string generateName = 2; |
| 1044 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1045 | # Is required when creating |
| 1046 | # resources, although some resources may allow a client to request the |
| 1047 | # generation of an appropriate name automatically. Name is primarily intended |
| 1048 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1049 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1050 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1051 | "deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run. |
| 1052 | # |
| 1053 | # Number of seconds allowed for this object to gracefully terminate before |
| 1054 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1055 | # set. May only be shortened. Read-only. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1056 | "clusterName": "A String", # Not currently supported by Cloud Run. |
| 1057 | # |
| 1058 | # The name of the cluster which the object belongs to. |
| 1059 | # This is used to distinguish resources with same name and namespace in |
| 1060 | # different clusters. This field is not set anywhere right now and apiserver |
| 1061 | # 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] | 1062 | "finalizers": [ # Not currently supported by Cloud Run. |
| 1063 | # |
| 1064 | # Must be empty before the object is deleted from the registry. Each entry |
| 1065 | # is an identifier for the responsible component that will remove the entry |
| 1066 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1067 | # in this list can only be removed. |
| 1068 | # +optional |
| 1069 | # +patchStrategy=merge |
| 1070 | "A String", |
| 1071 | ], |
| 1072 | "deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1073 | # deleted. This field is set by the server when a graceful deletion is |
| 1074 | # requested by the user, and is not directly settable by a client. The |
| 1075 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1076 | # and not reachable by name) after the time in this field, once the |
| 1077 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1078 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1079 | # be unset or be set further into the future, although it may be shortened or |
| 1080 | # the resource may be deleted prior to this time. For example, a user may |
| 1081 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1082 | # sending a graceful termination signal to the containers in the pod. After |
| 1083 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1084 | # to the container and after cleanup, remove the pod from the API. In the |
| 1085 | # presence of network partitions, this object may still exist after this |
| 1086 | # timestamp, until an administrator or automated process can determine the |
| 1087 | # resource is fully terminated. |
| 1088 | # If not set, graceful deletion of the object has not been requested. |
| 1089 | # |
| 1090 | # Populated by the system when a graceful deletion is requested. |
| 1091 | # Read-only. |
| 1092 | # More info: |
| 1093 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1094 | # +optional |
| 1095 | "ownerReferences": [ # List of objects that own this object. If ALL objects in the list have |
| 1096 | # been deleted, this object will be garbage collected. |
| 1097 | # +optional |
| 1098 | { # OwnerReference contains enough information to let you identify an owning |
| 1099 | # object. Currently, an owning object must be in the same namespace, so there |
| 1100 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1101 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1102 | # +optional |
| 1103 | "kind": "A String", # Kind of the referent. |
| 1104 | # More info: |
| 1105 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1106 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1107 | # the owner cannot be deleted from the key-value store until this |
| 1108 | # reference is removed. |
| 1109 | # Defaults to false. |
| 1110 | # To set this field, a user needs "delete" permission of the owner, |
| 1111 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1112 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1113 | "apiVersion": "A String", # API version of the referent. |
| 1114 | "name": "A String", # Name of the referent. |
| 1115 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1116 | "uid": "A String", # UID of the referent. |
| 1117 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1118 | }, |
| 1119 | ], |
| 1120 | "creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this |
| 1121 | # object was created. It is not guaranteed to be set in happens-before order |
| 1122 | # across separate operations. Clients may not set this value. It is |
| 1123 | # represented in RFC3339 form and is in UTC. |
| 1124 | # |
| 1125 | # Populated by the system. |
| 1126 | # Read-only. |
| 1127 | # Null for lists. |
| 1128 | # More info: |
| 1129 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1130 | # +optional |
| 1131 | "labels": { # Map of string keys and values that can be used to organize and categorize |
| 1132 | # (scope and select) objects. May match selectors of replication controllers |
| 1133 | # and routes. |
| 1134 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1135 | # +optional |
| 1136 | "a_key": "A String", |
| 1137 | }, |
| 1138 | "generation": 42, # A sequence number representing a specific generation of the desired state. |
| 1139 | # Populated by the system. Read-only. |
| 1140 | # +optional |
| 1141 | "resourceVersion": "A String", # An opaque value that represents the internal version of this object that |
| 1142 | # can be used by clients to determine when objects have changed. May be used |
| 1143 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1144 | # resource or set of resources. Clients must treat these values as opaque and |
| 1145 | # passed unmodified back to the server. They may only be valid for a |
| 1146 | # particular resource or set of resources. |
| 1147 | # |
| 1148 | # Populated by the system. |
| 1149 | # Read-only. |
| 1150 | # Value must be treated as opaque by clients and . |
| 1151 | # More info: |
| 1152 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1153 | # +optional |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1154 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 1155 | # Populated by the system. |
| 1156 | # Read-only. |
| 1157 | # +optional |
| 1158 | # string selfLink = 4; |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1159 | "uid": "A String", # UID is the unique in time and space value for this object. It is typically |
| 1160 | # generated by the server on successful creation of a resource and is not |
| 1161 | # allowed to change on PUT operations. |
| 1162 | # |
| 1163 | # Populated by the system. |
| 1164 | # Read-only. |
| 1165 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1166 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1167 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1168 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1169 | # project ID or project number. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1170 | "annotations": { # Annotations is an unstructured key value map stored with a resource that |
| 1171 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1172 | # are not queryable and should be preserved when modifying objects. More |
| 1173 | # info: http://kubernetes.io/docs/user-guide/annotations +optional |
| 1174 | "a_key": "A String", |
| 1175 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1176 | }, |
| 1177 | }, |
| 1178 | ], |
| 1179 | "apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1180 | }</pre> |
| 1181 | </div> |
| 1182 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1183 | </body></html> |