Page (proto-google-cloud-dialogflow-cx-v3 0.17.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.dialogflow.cx.v3.Page

All Implemented Interfaces:: PageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Page
extends com.google.protobuf.GeneratedMessageV3
implements PageOrBuilder

 A Dialogflow CX conversation (session) can be described and visualized as a
 state machine. The states of a CX session are represented by pages.
 For each flow, you define many pages, where your combined pages can handle a
 complete conversation on the topics the flow is designed for. At any given
 moment, exactly one page is the current page, the current page is considered
 active, and the flow associated with that page is considered active. Every
 flow has a special start page. When a flow initially becomes active, the
 start page page becomes the current page. For each conversational turn, the
 current page will either stay the same or transition to another page.
 You configure each page to collect information from the end-user that is
 relevant for the conversational state represented by the page.
 For more information, see the
 [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).

Protobuf type google.cloud.dialogflow.cx.v3.Page

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Page.Builder
A Dialogflow CX conversation (session) can be described and visualized as a state machine.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`Page.Builder` A Dialogflow CX conversation (session) can be described and visualized as a state machine.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`ENTRY_FULFILLMENT_FIELD_NUMBER`
`static int`	`EVENT_HANDLERS_FIELD_NUMBER`
`static int`	`FORM_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`TRANSITION_ROUTE_GROUPS_FIELD_NUMBER`
`static int`	`TRANSITION_ROUTES_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static Page`	`getDefaultInstance()`
`Page`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`Fulfillment`	`getEntryFulfillment()` The fulfillment to call when the session is entering the page.
`FulfillmentOrBuilder`	`getEntryFulfillmentOrBuilder()` The fulfillment to call when the session is entering the page.
`EventHandler`	`getEventHandlers(int index)` Handlers associated with the page to handle events such as webhook errors, no match or no input.
`int`	`getEventHandlersCount()` Handlers associated with the page to handle events such as webhook errors, no match or no input.
`List<EventHandler>`	`getEventHandlersList()` Handlers associated with the page to handle events such as webhook errors, no match or no input.
`EventHandlerOrBuilder`	`getEventHandlersOrBuilder(int index)` Handlers associated with the page to handle events such as webhook errors, no match or no input.
`List<? extends EventHandlerOrBuilder>`	`getEventHandlersOrBuilderList()` Handlers associated with the page to handle events such as webhook errors, no match or no input.
`Form`	`getForm()` The form associated with the page, used for collecting parameters relevant to the page.
`FormOrBuilder`	`getFormOrBuilder()` The form associated with the page, used for collecting parameters relevant to the page.
`String`	`getName()` The unique identifier of the page.
`com.google.protobuf.ByteString`	`getNameBytes()` The unique identifier of the page.
`com.google.protobuf.Parser<Page>`	`getParserForType()`
`int`	`getSerializedSize()`
`String`	`getTransitionRouteGroups(int index)` Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated with the page.
`com.google.protobuf.ByteString`	`getTransitionRouteGroupsBytes(int index)` Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated with the page.
`int`	`getTransitionRouteGroupsCount()` Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated with the page.
`com.google.protobuf.ProtocolStringList`	`getTransitionRouteGroupsList()` Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated with the page.
`TransitionRoute`	`getTransitionRoutes(int index)` A list of transitions for the transition rules of this page.
`int`	`getTransitionRoutesCount()` A list of transitions for the transition rules of this page.
`List<TransitionRoute>`	`getTransitionRoutesList()` A list of transitions for the transition rules of this page.
`TransitionRouteOrBuilder`	`getTransitionRoutesOrBuilder(int index)` A list of transitions for the transition rules of this page.
`List<? extends TransitionRouteOrBuilder>`	`getTransitionRoutesOrBuilderList()` A list of transitions for the transition rules of this page.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasEntryFulfillment()` The fulfillment to call when the session is entering the page.
`boolean`	`hasForm()` The form associated with the page, used for collecting parameters relevant to the page.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Page.Builder`	`newBuilder()`
`static Page.Builder`	`newBuilder(Page prototype)`
`Page.Builder`	`newBuilderForType()`
`protected Page.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Page`	`parseDelimitedFrom(InputStream input)`
`static Page`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(byte[] data)`
`static Page`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(ByteBuffer data)`
`static Page`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(com.google.protobuf.ByteString data)`
`static Page`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Page`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(InputStream input)`
`static Page`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Page>`	`parser()`
`Page.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENTRY_FULFILLMENT_FIELD_NUMBER
```
public static final int ENTRY_FULFILLMENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FORM_FIELD_NUMBER
```
public static final int FORM_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRANSITION_ROUTE_GROUPS_FIELD_NUMBER
```
public static final int TRANSITION_ROUTE_GROUPS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRANSITION_ROUTES_FIELD_NUMBER
```
public static final int TRANSITION_ROUTES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EVENT_HANDLERS_FIELD_NUMBER
```
public static final int EVENT_HANDLERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The unique identifier of the page.
 Required for the [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/pages/<Page ID>`.

string name = 1;

Specified by:: getName in interface PageOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The unique identifier of the page.
 Required for the [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/pages/<Page ID>`.

string name = 1;

Specified by:: getNameBytes in interface PageOrBuilder
Returns:: The bytes for name.

getDisplayName
```
public String getDisplayName()
```
```
 Required. The human-readable name of the page, unique within the flow.
 
```
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getDisplayName in interface PageOrBuilder

Returns:

The displayName.

getDisplayNameBytes
```
public com.google.protobuf.ByteString getDisplayNameBytes()
```
```
 Required. The human-readable name of the page, unique within the flow.
 
```
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getDisplayNameBytes in interface PageOrBuilder

Returns:

The bytes for displayName.

hasEntryFulfillment
```
public boolean hasEntryFulfillment()
```
```
 The fulfillment to call when the session is entering the page.
 
```
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
Specified by:

hasEntryFulfillment in interface PageOrBuilder

Returns:

Whether the entryFulfillment field is set.

getEntryFulfillment
```
public Fulfillment getEntryFulfillment()
```
```
 The fulfillment to call when the session is entering the page.
 
```
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
Specified by:

getEntryFulfillment in interface PageOrBuilder

Returns:

The entryFulfillment.

getEntryFulfillmentOrBuilder
```
public FulfillmentOrBuilder getEntryFulfillmentOrBuilder()
```
```
 The fulfillment to call when the session is entering the page.
 
```
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
Specified by:

getEntryFulfillmentOrBuilder in interface PageOrBuilder

hasForm
```
public boolean hasForm()
```
```
 The form associated with the page, used for collecting parameters
 relevant to the page.
 
```
.google.cloud.dialogflow.cx.v3.Form form = 4;
Specified by:

hasForm in interface PageOrBuilder

Returns:

Whether the form field is set.

getForm

public Form getForm()

 The form associated with the page, used for collecting parameters
 relevant to the page.

.google.cloud.dialogflow.cx.v3.Form form = 4;

Specified by:: getForm in interface PageOrBuilder
Returns:: The form.

getFormOrBuilder

public FormOrBuilder getFormOrBuilder()

 The form associated with the page, used for collecting parameters
 relevant to the page.

.google.cloud.dialogflow.cx.v3.Form form = 4;

Specified by:: getFormOrBuilder in interface PageOrBuilder

getTransitionRouteGroupsList

public com.google.protobuf.ProtocolStringList getTransitionRouteGroupsList()

 Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated
 with the page. Transition route groups must be unique within a page.
 *   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.
 *   If multiple transition route groups within a page contain the same
     intent, then the first group in the ordered list takes precedence.
 Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`.

repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }

Specified by:: getTransitionRouteGroupsList in interface PageOrBuilder
Returns:: A list containing the transitionRouteGroups.

getTransitionRouteGroupsCount

public int getTransitionRouteGroupsCount()

 Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated
 with the page. Transition route groups must be unique within a page.
 *   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.
 *   If multiple transition route groups within a page contain the same
     intent, then the first group in the ordered list takes precedence.
 Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`.

repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }

Specified by:: getTransitionRouteGroupsCount in interface PageOrBuilder
Returns:: The count of transitionRouteGroups.

getTransitionRouteGroups

public String getTransitionRouteGroups(int index)

 Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated
 with the page. Transition route groups must be unique within a page.
 *   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.
 *   If multiple transition route groups within a page contain the same
     intent, then the first group in the ordered list takes precedence.
 Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`.

repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }

Specified by:: getTransitionRouteGroups in interface PageOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The transitionRouteGroups at the given index.

getTransitionRouteGroupsBytes

public com.google.protobuf.ByteString getTransitionRouteGroupsBytes(int index)

 Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated
 with the page. Transition route groups must be unique within a page.
 *   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.
 *   If multiple transition route groups within a page contain the same
     intent, then the first group in the ordered list takes precedence.
 Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`.

repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }

Specified by:: getTransitionRouteGroupsBytes in interface PageOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the transitionRouteGroups at the given index.