1apiVersion: apiextensions.k8s.io/v1
2kind: CustomResourceDefinition
3metadata:
4 annotations:
5 cnrm.cloud.google.com/version: 0.0.0-dev
6 creationTimestamp: null
7 labels:
8 cnrm.cloud.google.com/managed-by-kcc: "true"
9 cnrm.cloud.google.com/stability-level: alpha
10 cnrm.cloud.google.com/system: "true"
11 cnrm.cloud.google.com/tf2crd: "true"
12 name: dialogflowcxpages.dialogflowcx.cnrm.cloud.google.com
13spec:
14 group: dialogflowcx.cnrm.cloud.google.com
15 names:
16 categories:
17 - gcp
18 kind: DialogflowCXPage
19 plural: dialogflowcxpages
20 shortNames:
21 - gcpdialogflowcxpage
22 - gcpdialogflowcxpages
23 singular: dialogflowcxpage
24 preserveUnknownFields: false
25 scope: Namespaced
26 versions:
27 - additionalPrinterColumns:
28 - jsonPath: .metadata.creationTimestamp
29 name: Age
30 type: date
31 - description: When 'True', the most recent reconcile of the resource succeeded
32 jsonPath: .status.conditions[?(@.type=='Ready')].status
33 name: Ready
34 type: string
35 - description: The reason for the value in 'Ready'
36 jsonPath: .status.conditions[?(@.type=='Ready')].reason
37 name: Status
38 type: string
39 - description: The last transition time for the value in 'Status'
40 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
41 name: Status Age
42 type: date
43 name: v1alpha1
44 schema:
45 openAPIV3Schema:
46 properties:
47 apiVersion:
48 description: 'apiVersion defines the versioned schema of this representation
49 of an object. Servers should convert recognized schemas to the latest
50 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
51 type: string
52 kind:
53 description: 'kind is a string value representing the REST resource this
54 object represents. Servers may infer this from the endpoint the client
55 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
56 type: string
57 metadata:
58 type: object
59 spec:
60 properties:
61 displayName:
62 description: The human-readable name of the page, unique within the
63 agent.
64 type: string
65 entryFulfillment:
66 description: The fulfillment to call when the session is entering
67 the page.
68 properties:
69 messages:
70 description: The list of rich message responses to present to
71 the user.
72 items:
73 properties:
74 text:
75 description: The text response message.
76 properties:
77 allowPlaybackInterruption:
78 description: Whether the playback of this message can
79 be interrupted by the end user's speech and the client
80 can then starts the next Dialogflow request.
81 type: boolean
82 text:
83 description: A collection of text responses.
84 items:
85 type: string
86 type: array
87 type: object
88 type: object
89 type: array
90 returnPartialResponses:
91 description: 'Whether Dialogflow should return currently queued
92 fulfillment response messages in streaming APIs. If a webhook
93 is specified, it happens before Dialogflow invokes webhook.
94 Warning: 1) This flag only affects streaming API. Responses
95 are still queued and returned once in non-streaming API. 2)
96 The flag can be enabled in any fulfillment but only the first
97 3 partial responses will be returned. You may only want to apply
98 it to fulfillments that have slow webhooks.'
99 type: boolean
100 tag:
101 description: The tag used by the webhook to identify which fulfillment
102 is being called. This field is required if webhook is specified.
103 type: string
104 webhook:
105 description: 'The webhook to call. Format: projects/<Project ID>/locations/<Location
106 ID>/agents/<Agent ID>/webhooks/<Webhook ID>.'
107 type: string
108 type: object
109 eventHandlers:
110 description: Handlers associated with the page to handle events such
111 as webhook errors, no match or no input.
112 items:
113 properties:
114 event:
115 description: The name of the event to handle.
116 type: string
117 name:
118 description: The unique identifier of this event handler.
119 type: string
120 targetFlow:
121 description: |-
122 The target flow to transition to.
123 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
124 type: string
125 targetPage:
126 description: |-
127 The target page to transition to.
128 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
129 type: string
130 triggerFulfillment:
131 description: The fulfillment to call when the event occurs.
132 Handling webhook errors with a fulfillment enabled with webhook
133 could cause infinite loop. It is invalid to specify such fulfillment
134 for a handler handling webhooks.
135 properties:
136 messages:
137 description: The list of rich message responses to present
138 to the user.
139 items:
140 properties:
141 text:
142 description: The text response message.
143 properties:
144 allowPlaybackInterruption:
145 description: Whether the playback of this message
146 can be interrupted by the end user's speech
147 and the client can then starts the next Dialogflow
148 request.
149 type: boolean
150 text:
151 description: A collection of text responses.
152 items:
153 type: string
154 type: array
155 type: object
156 type: object
157 type: array
158 returnPartialResponses:
159 description: 'Whether Dialogflow should return currently
160 queued fulfillment response messages in streaming APIs.
161 If a webhook is specified, it happens before Dialogflow
162 invokes webhook. Warning: 1) This flag only affects streaming
163 API. Responses are still queued and returned once in non-streaming
164 API. 2) The flag can be enabled in any fulfillment but
165 only the first 3 partial responses will be returned. You
166 may only want to apply it to fulfillments that have slow
167 webhooks.'
168 type: boolean
169 tag:
170 description: The tag used by the webhook to identify which
171 fulfillment is being called. This field is required if
172 webhook is specified.
173 type: string
174 webhook:
175 description: 'The webhook to call. Format: projects/<Project
176 ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook
177 ID>.'
178 type: string
179 type: object
180 type: object
181 type: array
182 form:
183 description: The form associated with the page, used for collecting
184 parameters relevant to the page.
185 properties:
186 parameters:
187 description: Parameters to collect from the user.
188 items:
189 properties:
190 displayName:
191 description: The human-readable name of the parameter, unique
192 within the form.
193 type: string
194 entityType:
195 description: |-
196 The entity type of the parameter.
197 Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.
198 type: string
199 fillBehavior:
200 description: Defines fill behavior for the parameter.
201 properties:
202 initialPromptFulfillment:
203 description: The fulfillment to provide the initial
204 prompt that the agent can present to the user in order
205 to fill the parameter.
206 properties:
207 messages:
208 description: The list of rich message responses
209 to present to the user.
210 items:
211 properties:
212 text:
213 description: The text response message.
214 properties:
215 allowPlaybackInterruption:
216 description: Whether the playback of this
217 message can be interrupted by the end
218 user's speech and the client can then
219 starts the next Dialogflow request.
220 type: boolean
221 text:
222 description: A collection of text responses.
223 items:
224 type: string
225 type: array
226 type: object
227 type: object
228 type: array
229 returnPartialResponses:
230 description: 'Whether Dialogflow should return currently
231 queued fulfillment response messages in streaming
232 APIs. If a webhook is specified, it happens before
233 Dialogflow invokes webhook. Warning: 1) This flag
234 only affects streaming API. Responses are still
235 queued and returned once in non-streaming API.
236 2) The flag can be enabled in any fulfillment
237 but only the first 3 partial responses will be
238 returned. You may only want to apply it to fulfillments
239 that have slow webhooks.'
240 type: boolean
241 tag:
242 description: The tag used by the webhook to identify
243 which fulfillment is being called. This field
244 is required if webhook is specified.
245 type: string
246 webhook:
247 description: 'The webhook to call. Format: projects/<Project
248 ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook
249 ID>.'
250 type: string
251 type: object
252 type: object
253 isList:
254 description: Indicates whether the parameter represents
255 a list of values.
256 type: boolean
257 redact:
258 description: |-
259 Indicates whether the parameter content should be redacted in log.
260 If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
261 type: boolean
262 required:
263 description: |-
264 Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them.
265 Required parameters must be filled before form filling concludes.
266 type: boolean
267 type: object
268 type: array
269 type: object
270 languageCode:
271 description: |-
272 Immutable. The language of the following fields in page:
273
274 Page.entry_fulfillment.messages
275 Page.entry_fulfillment.conditional_cases
276 Page.event_handlers.trigger_fulfillment.messages
277 Page.event_handlers.trigger_fulfillment.conditional_cases
278 Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages
279 Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
280 Page.form.parameters.fill_behavior.reprompt_event_handlers.messages
281 Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
282 Page.transition_routes.trigger_fulfillment.messages
283 Page.transition_routes.trigger_fulfillment.conditional_cases
284 If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
285 type: string
286 parent:
287 description: |-
288 Immutable. The flow to create a page for.
289 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
290 type: string
291 resourceID:
292 description: Immutable. Optional. The service-generated name of the
293 resource. Used for acquisition only. Leave unset to create a new
294 resource.
295 type: string
296 transitionRouteGroups:
297 description: |-
298 Ordered list of TransitionRouteGroups associated with the page. Transition route groups must be unique within a page.
299 If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes.
300 If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence.
301 Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>.
302 items:
303 type: string
304 type: array
305 transitionRoutes:
306 description: |-
307 A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow.
308 When we are in a certain page, the TransitionRoutes are evalauted in the following order:
309 TransitionRoutes defined in the page with intent specified.
310 TransitionRoutes defined in the transition route groups with intent specified.
311 TransitionRoutes defined in flow with intent specified.
312 TransitionRoutes defined in the transition route groups with intent specified.
313 TransitionRoutes defined in the page with only condition specified.
314 TransitionRoutes defined in the transition route groups with only condition specified.
315 items:
316 properties:
317 condition:
318 description: |-
319 The condition to evaluate against form parameters or session parameters.
320 At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.
321 type: string
322 intent:
323 description: |-
324 The unique identifier of an Intent.
325 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.
326 type: string
327 name:
328 description: The unique identifier of this transition route.
329 type: string
330 targetFlow:
331 description: |-
332 The target flow to transition to.
333 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
334 type: string
335 targetPage:
336 description: |-
337 The target page to transition to.
338 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
339 type: string
340 triggerFulfillment:
341 description: The fulfillment to call when the event occurs.
342 Handling webhook errors with a fulfillment enabled with webhook
343 could cause infinite loop. It is invalid to specify such fulfillment
344 for a handler handling webhooks.
345 properties:
346 messages:
347 description: The list of rich message responses to present
348 to the user.
349 items:
350 properties:
351 text:
352 description: The text response message.
353 properties:
354 allowPlaybackInterruption:
355 description: Whether the playback of this message
356 can be interrupted by the end user's speech
357 and the client can then starts the next Dialogflow
358 request.
359 type: boolean
360 text:
361 description: A collection of text responses.
362 items:
363 type: string
364 type: array
365 type: object
366 type: object
367 type: array
368 returnPartialResponses:
369 description: 'Whether Dialogflow should return currently
370 queued fulfillment response messages in streaming APIs.
371 If a webhook is specified, it happens before Dialogflow
372 invokes webhook. Warning: 1) This flag only affects streaming
373 API. Responses are still queued and returned once in non-streaming
374 API. 2) The flag can be enabled in any fulfillment but
375 only the first 3 partial responses will be returned. You
376 may only want to apply it to fulfillments that have slow
377 webhooks.'
378 type: boolean
379 tag:
380 description: The tag used by the webhook to identify which
381 fulfillment is being called. This field is required if
382 webhook is specified.
383 type: string
384 webhook:
385 description: 'The webhook to call. Format: projects/<Project
386 ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook
387 ID>.'
388 type: string
389 type: object
390 type: object
391 type: array
392 required:
393 - displayName
394 type: object
395 status:
396 properties:
397 conditions:
398 description: Conditions represent the latest available observation
399 of the resource's current state.
400 items:
401 properties:
402 lastTransitionTime:
403 description: Last time the condition transitioned from one status
404 to another.
405 type: string
406 message:
407 description: Human-readable message indicating details about
408 last transition.
409 type: string
410 reason:
411 description: Unique, one-word, CamelCase reason for the condition's
412 last transition.
413 type: string
414 status:
415 description: Status is the status of the condition. Can be True,
416 False, Unknown.
417 type: string
418 type:
419 description: Type is the type of the condition.
420 type: string
421 type: object
422 type: array
423 name:
424 description: |-
425 The unique identifier of the page.
426 Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
427 type: string
428 observedGeneration:
429 description: ObservedGeneration is the generation of the resource
430 that was most recently observed by the Config Connector controller.
431 If this is equal to metadata.generation, then that means that the
432 current reported status reflects the most recent desired state of
433 the resource.
434 type: integer
435 type: object
436 required:
437 - spec
438 type: object
439 served: true
440 storage: true
441 subresources:
442 status: {}
443status:
444 acceptedNames:
445 kind: ""
446 plural: ""
447 conditions: []
448 storedVersions: []
View as plain text