Google Cloud Dialogflow Cx V3 Client - Class GetPageRequest (0.3.2)

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

The request message for Pages.GetPage.

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

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The name of the page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
↳ language_code string

The language to retrieve the page 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.

getName

Required. The name of the page.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Returns
Type Description
string

setName

Required. The name of the page.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguageCode

The language to retrieve the page 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 retrieve the page 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

static::build

Parameter
Name Description
name string

Required. The name of the page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. Please see Google\Cloud\Dialogflow\Cx\V3\PagesClient::pageName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\GetPageRequest