Class TransitionRouteGroupsClient (0.1.1)

TransitionRouteGroupsClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.transition_route_groups.transports.base.TransitionRouteGroupsTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow-cx/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing TransitionRouteGroups.

Methods

TransitionRouteGroupsClient

TransitionRouteGroupsClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.transition_route_groups.transports.base.TransitionRouteGroupsTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow-cx/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the transition route groups client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .TransitionRouteGroupsTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

create_transition_route_group

create_transition_route_group(request: Optional[google.cloud.dialogflowcx_v3beta1.types.transition_route_group.CreateTransitionRouteGroupRequest] = None, *, parent: Optional[str] = None, transition_route_group: Optional[google.cloud.dialogflowcx_v3beta1.types.transition_route_group.TransitionRouteGroup] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an xref_TransitionRouteGroup in the specified flow.

Parameters
Name	Description
`request`	`.gcdc_transition_route_group.CreateTransitionRouteGroupRequest` The request object. The request message for TransitionRouteGroups.CreateTransitionRouteGroup.
`parent`	`str` Required. The flow to create an TransitionRouteGroup for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`transition_route_group`	`.gcdc_transition_route_group.TransitionRouteGroup` Required. The transition route group to create. This corresponds to the `transition_route_group` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.gcdc_transition_route_group.TransitionRouteGroup`	An TransitionRouteGroup represents a group of [`TransitionRoutes`][google.cloud.dialogflow.cx.v3beta1.TransitionRoute] to be used by a Page.

delete_transition_route_group

delete_transition_route_group(request: Optional[google.cloud.dialogflowcx_v3beta1.types.transition_route_group.DeleteTransitionRouteGroupRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified xref_TransitionRouteGroup.

Parameters
Name	Description
`request`	`.transition_route_group.DeleteTransitionRouteGroupRequest` The request object. The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.
`name`	`str` Required. The name of the TransitionRouteGroup to delete. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

get_transition_route_group

get_transition_route_group(request: Optional[google.cloud.dialogflowcx_v3beta1.types.transition_route_group.GetTransitionRouteGroupRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified xref_TransitionRouteGroup.

Parameters
Name	Description
`request`	`.transition_route_group.GetTransitionRouteGroupRequest` The request object. The request message for TransitionRouteGroups.GetTransitionRouteGroup.
`name`	`str` Required. The name of the TransitionRouteGroup. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.transition_route_group.TransitionRouteGroup`	An TransitionRouteGroup represents a group of [`TransitionRoutes`][google.cloud.dialogflow.cx.v3beta1.TransitionRoute] to be used by a Page.

list_transition_route_groups

list_transition_route_groups(request: Optional[google.cloud.dialogflowcx_v3beta1.types.transition_route_group.ListTransitionRouteGroupsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all transition route groups in the specified flow.

Parameters
Name	Description
`request`	`.transition_route_group.ListTransitionRouteGroupsRequest` The request object. The request message for TransitionRouteGroups.ListTransitionRouteGroups.
`parent`	`str` Required. The flow to list all transition route groups for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.pagers.ListTransitionRouteGroupsPager`	The response message for TransitionRouteGroups.ListTransitionRouteGroups. Iterating over this object will yield results and resolve additional pages automatically.

parse_transition_route_group_path

parse_transition_route_group_path(path: str)

Parse a transition_route_group path into its component segments.

transition_route_group_path

transition_route_group_path(
    project: str, location: str, agent: str, flow: str, transition_route_group: str
)

Return a fully-qualified transition_route_group string.

update_transition_route_group

update_transition_route_group(request: Optional[google.cloud.dialogflowcx_v3beta1.types.transition_route_group.UpdateTransitionRouteGroupRequest] = None, *, transition_route_group: Optional[google.cloud.dialogflowcx_v3beta1.types.transition_route_group.TransitionRouteGroup] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified xref_TransitionRouteGroup.

Parameters
Name	Description
`request`	`.gcdc_transition_route_group.UpdateTransitionRouteGroupRequest` The request object. The request message for TransitionRouteGroups.UpdateTransitionRouteGroup.
`transition_route_group`	`.gcdc_transition_route_group.TransitionRouteGroup` Required. The transition route group to update. This corresponds to the `transition_route_group` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`.field_mask.FieldMask` The mask to control which fields get updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.gcdc_transition_route_group.TransitionRouteGroup`	An TransitionRouteGroup represents a group of [`TransitionRoutes`][google.cloud.dialogflow.cx.v3beta1.TransitionRoute] to be used by a Page.