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