Google Cloud Dialogflow Cx V3 Client - Class ListFlowsRequest (0.4.0)

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

The request message for Flows.ListFlows.

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

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 agent containing the flows. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

↳ 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.

↳ language_code string

The language to list flows for. The following fields are language dependent: * Flow.event_handlers.trigger_fulfillment.messages * Flow.event_handlers.trigger_fulfillment.conditional_cases * Flow.transition_routes.trigger_fulfillment.messages * Flow.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.

getParent

Required. The agent containing the flows.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Returns
Type Description
string

setParent

Required. The agent containing the flows.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

getLanguageCode

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

  • Flow.event_handlers.trigger_fulfillment.messages
  • Flow.event_handlers.trigger_fulfillment.conditional_cases
  • Flow.transition_routes.trigger_fulfillment.messages
  • Flow.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 flows for. The following fields are language dependent:

  • Flow.event_handlers.trigger_fulfillment.messages
  • Flow.event_handlers.trigger_fulfillment.conditional_cases
  • Flow.transition_routes.trigger_fulfillment.messages
  • Flow.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
parent string

Required. The agent containing the flows. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. Please see Google\Cloud\Dialogflow\Cx\V3\FlowsClient::agentName() for help formatting this field.

Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\ListFlowsRequest