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

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

The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.

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

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 TransitionRouteGroup to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>.
↳ force bool

This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If force is set to false, an error will be returned with message indicating pages that reference the transition route group. * If force is set to true, Dialogflow will remove the transition route group, as well as any reference to it.

getName

Required. The name of the TransitionRouteGroup to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>.

Returns
Type Description
string

setName

Required. The name of the TransitionRouteGroup to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

This field has no effect for transition route group that no page is using.

If the transition route group is referenced by any page:

  • If force is set to false, an error will be returned with message indicating pages that reference the transition route group.
  • If force is set to true, Dialogflow will remove the transition route group, as well as any reference to it.
Returns
Type Description
bool

setForce

This field has no effect for transition route group that no page is using.

If the transition route group is referenced by any page:

  • If force is set to false, an error will be returned with message indicating pages that reference the transition route group.
  • If force is set to true, Dialogflow will remove the transition route group, as well as any reference to it.
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the TransitionRouteGroup to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>. Please see Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroupsClient::transitionRouteGroupName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\DeleteTransitionRouteGroupRequest