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