Google Cloud Dialogflow Cx V3 Client - Class ListPagesRequest (0.5.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class ListPagesRequest.

The request message for Pages.ListPages.

Generated from protobuf message google.cloud.dialogflow.cx.v3.ListPagesRequest

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The flow to list all pages for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.
↳ language_code string

The language to list pages for. The following fields are language dependent: * * Page.entry_fulfillment.messages * * Page.entry_fulfillment.conditional_cases * * Page.event_handlers.trigger_fulfillment.messages * * Page.event_handlers.trigger_fulfillment.conditional_cases * * Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases * * Page.form.parameters.fill_behavior.reprompt_event_handlers.messages * Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases * * Page.transition_routes.trigger_fulfillment.messages * * Page.transition_routes.trigger_fulfillment.conditional_cases 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.
↳ page_size int

The maximum number of items to return in a single page. By default 100 and at most 1000.
↳ page_token string

The next_page_token value returned from a previous list request.

getParent

Required. The flow to list all pages for.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Returns
Type Description
string

setParent

Required. The flow to list all pages for.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguageCode

The language to list pages for. The following fields are language dependent:

  • Page.entry_fulfillment.messages
  • Page.entry_fulfillment.conditional_cases
  • Page.event_handlers.trigger_fulfillment.messages
  • Page.event_handlers.trigger_fulfillment.conditional_cases
  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages * Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
  • Page.transition_routes.trigger_fulfillment.messages
  • Page.transition_routes.trigger_fulfillment.conditional_cases 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.

Returns
Type Description
string

setLanguageCode

The language to list pages for. The following fields are language dependent:

  • Page.entry_fulfillment.messages
  • Page.entry_fulfillment.conditional_cases
  • Page.event_handlers.trigger_fulfillment.messages
  • Page.event_handlers.trigger_fulfillment.conditional_cases
  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages * Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
  • Page.transition_routes.trigger_fulfillment.messages
  • Page.transition_routes.trigger_fulfillment.conditional_cases 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.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of items to return in a single page. By default 100 and at most 1000.

Returns
Type Description
int

setPageSize

The maximum number of items to return in a single page. By default 100 and at most 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The next_page_token value returned from a previous list request.

Returns
Type Description
string

setPageToken

The next_page_token value returned from a previous list request.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The flow to list all pages for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. Please see PagesClient::flowName() for help formatting this field.
Returns
Type Description
ListPagesRequest