Class PagesClient (0.7.1)

PagesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.services.pages.transports.base.PagesTransport]] = 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 Pages.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`PagesTransport`	The transport used by the client instance.

Methods

PagesClient

PagesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.services.pages.transports.base.PagesTransport]] = 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>)

Instantiates the pages 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, PagesTransport]` 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)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_page

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

Creates a page in the specified flow.

Parameters
Name	Description
`request`	`google.cloud.dialogflowcx_v3beta1.types.CreatePageRequest` The request object. The request message for Pages.CreatePage.
`parent`	`str` Required. The flow to create a page for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`page`	`google.cloud.dialogflowcx_v3beta1.types.Page` Required. The page to create. This corresponds to the `page` 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_v3beta1.types.Page A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](\ https://cloud.google.com/dialogflow/cx/docs/concept/page).

delete_page

delete_page(request: Optional[google.cloud.dialogflowcx_v3beta1.types.page.DeletePageRequest] = 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 page.

Parameters
Name	Description
`request`	`google.cloud.dialogflowcx_v3beta1.types.DeletePageRequest` The request object. The request message for Pages.DeletePage.
`name`	`str` Required. The name of the page 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.

entity_type_path

entity_type_path(project: str, location: str, agent: str, entity_type: str)

Returns a fully-qualified entity_type string.

flow_path

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

Returns 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
`PagesClient`	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
`PagesClient`	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
`PagesClient`	The constructed client.

get_page

get_page(request: Optional[google.cloud.dialogflowcx_v3beta1.types.page.GetPageRequest] = 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 page.

Parameters
Name	Description
`request`	`google.cloud.dialogflowcx_v3beta1.types.GetPageRequest` The request object. The request message for Pages.GetPage.
`name`	`str` Required. The name of the page. 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

intent_path

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

Returns a fully-qualified intent string.

list_pages

list_pages(request: Optional[google.cloud.dialogflowcx_v3beta1.types.page.ListPagesRequest] = 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 pages in the specified flow.

Parameters
Name	Description
`request`	`google.cloud.dialogflowcx_v3beta1.types.ListPagesRequest` The request object. The request message for Pages.ListPages.
`parent`	`str` Required. The flow to list all pages 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_v3beta1.services.pages.pagers.ListPagesPager`	The response message for Pages.ListPages. 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)

Returns 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_entity_type_path

parse_entity_type_path(path: str)

Parses a entity_type path into its component segments.

parse_flow_path

parse_flow_path(path: str)

Parses a flow path into its component segments.

parse_intent_path

parse_intent_path(path: str)

Parses a intent path into its component segments.

parse_page_path

parse_page_path(path: str)

Parses a page path into its component segments.

parse_transition_route_group_path

parse_transition_route_group_path(path: str)

Parses a transition_route_group path into its component segments.

parse_webhook_path

parse_webhook_path(path: str)

Parses 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
)

Returns a fully-qualified transition_route_group string.

update_page

update_page(request: Optional[google.cloud.dialogflowcx_v3beta1.types.page.UpdatePageRequest] = None, *, page: Optional[google.cloud.dialogflowcx_v3beta1.types.page.Page] = 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 page.

Parameters
Name	Description
`request`	`google.cloud.dialogflowcx_v3beta1.types.UpdatePageRequest` The request object. The request message for Pages.UpdatePage.
`page`	`google.cloud.dialogflowcx_v3beta1.types.Page` Required. The page to update. This corresponds to the `page` 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. If the mask is not present, all fields will be 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

webhook_path

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

Returns a fully-qualified webhook string.