Class TransitionRouteGroupsClient (0.4.1)

Version 0.4.1

• 1.37.0 (latest)
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

TransitionRouteGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.transition_route_groups.transports.base.TransitionRouteGroupsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing TransitionRouteGroups.

Properties

transport

Return the transport used by the client instance.

Returns
Type	Description
TransitionRouteGroupsTransport	The transport used by the client instance.

Methods

TransitionRouteGroupsClient

TransitionRouteGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.transition_route_groups.transports.base.TransitionRouteGroupsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = 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	google.api_core.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_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
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.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_transition_route_group

create_transition_route_group(request: Optional[google.cloud.dialogflowcx_v3.types.transition_route_group.CreateTransitionRouteGroupRequest] = None, *, parent: Optional[str] = None, transition_route_group: Optional[google.cloud.dialogflowcx_v3.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	google.cloud.dialogflowcx_v3.types.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	google.cloud.dialogflowcx_v3.types.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
google.cloud.dialogflowcx_v3.types.TransitionRouteGroup	An TransitionRouteGroup represents a group of TransitionRoutes to be used by a Page.

delete_transition_route_group

delete_transition_route_group(request: Optional[google.cloud.dialogflowcx_v3.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	google.cloud.dialogflowcx_v3.types.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.

flow_path

flow_path(project: str, location: str, agent: str, flow: str)

Return a fully-qualified flow string.

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
TransitionRouteGroupsClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name	Description
info	dict The service account private key info.

Returns
Type	Description
TransitionRouteGroupsClient	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
TransitionRouteGroupsClient	The constructed client.

get_transition_route_group

get_transition_route_group(request: Optional[google.cloud.dialogflowcx_v3.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	google.cloud.dialogflowcx_v3.types.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
google.cloud.dialogflowcx_v3.types.TransitionRouteGroup	An TransitionRouteGroup represents a group of TransitionRoutes to be used by a Page.

intent_path

intent_path(project: str, location: str, agent: str, intent: str)

Return a fully-qualified intent string.

list_transition_route_groups

list_transition_route_groups(request: Optional[google.cloud.dialogflowcx_v3.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	google.cloud.dialogflowcx_v3.types.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
google.cloud.dialogflowcx_v3.services.transition_route_groups.pagers.ListTransitionRouteGroupsPager	The response message for TransitionRouteGroups.ListTransitionRouteGroups. Iterating over this object will yield results and resolve additional pages automatically.

page_path

page_path(project: str, location: str, agent: str, flow: str, page: str)

Return a fully-qualified page string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_flow_path

parse_flow_path(path: str)

Parse a flow path into its component segments.

parse_intent_path

parse_intent_path(path: str)

Parse a intent path into its component segments.

parse_page_path

parse_page_path(path: str)

Parse a page path into its component segments.

parse_transition_route_group_path

parse_transition_route_group_path(path: str)

Parse a transition_route_group path into its component segments.

parse_webhook_path

parse_webhook_path(path: str)

Parse a webhook 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_v3.types.transition_route_group.UpdateTransitionRouteGroupRequest] = None, *, transition_route_group: Optional[google.cloud.dialogflowcx_v3.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	google.cloud.dialogflowcx_v3.types.UpdateTransitionRouteGroupRequest The request object. The request message for TransitionRouteGroups.UpdateTransitionRouteGroup.
transition_route_group	google.cloud.dialogflowcx_v3.types.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	google.protobuf.field_mask_pb2.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
google.cloud.dialogflowcx_v3.types.TransitionRouteGroup	An TransitionRouteGroup represents a group of TransitionRoutes to be used by a Page.

webhook_path

webhook_path(project: str, location: str, agent: str, webhook: str)

Return a fully-qualified webhook string.