Package Methods (0.17.0)

Version latest

• 0.17.0 (latest)
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.12
• 0.12.3
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

Summary of entries of Methods for discoveryengine.

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient

AssistantServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.assistant_service.transports.base.AssistantServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.assistant_service.transports.base.AssistantServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the assistant service async client.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.assist_answer_path

assist_answer_path(
    project: str,
    location: str,
    collection: str,
    engine: str,
    session: str,
    assist_answer: str,
) -> str

Returns a fully-qualified assist_answer string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.assist_answer_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.assistant_path

assistant_path(
    project: str, location: str, collection: str, engine: str, assistant: str
) -> str

Returns a fully-qualified assistant string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.assistant_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.document_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.assistant_service.transports.base.AssistantServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_assist_answer_path

parse_assist_answer_path(path: str) -> typing.Dict[str, str]

Parses a assist_answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_assist_answer_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_assistant_path

parse_assistant_path(path: str) -> typing.Dict[str, str]

Parses a assistant path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_assistant_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_document_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.parse_session_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.session_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.stream_assist

stream_assist(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.assistant_service.StreamAssistRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> typing.Awaitable[
    typing.AsyncIterable[
        google.cloud.discoveryengine_v1.types.assistant_service.StreamAssistResponse
    ]
]

Assists the user with a query in a streaming fashion.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceAsyncClient.stream_assist

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient

AssistantServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.assistant_service.transports.base.AssistantServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.assistant_service.transports.base.AssistantServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the assistant service client.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.exit

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.assist_answer_path

assist_answer_path(
    project: str,
    location: str,
    collection: str,
    engine: str,
    session: str,
    assist_answer: str,
) -> str

Returns a fully-qualified assist_answer string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.assist_answer_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.assistant_path

assistant_path(
    project: str, location: str, collection: str, engine: str, assistant: str
) -> str

Returns a fully-qualified assistant string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.assistant_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.document_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.get_operation

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.list_operations

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_assist_answer_path

parse_assist_answer_path(path: str) -> typing.Dict[str, str]

Parses a assist_answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_assist_answer_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_assistant_path

parse_assistant_path(path: str) -> typing.Dict[str, str]

Parses a assistant path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_assistant_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_document_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.parse_session_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.session_path

google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.stream_assist

stream_assist(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.assistant_service.StreamAssistRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> typing.Iterable[
    google.cloud.discoveryengine_v1.types.assistant_service.StreamAssistResponse
]

Assists the user with a query in a streaming fashion.

See more: google.cloud.discoveryengine_v1.services.assistant_service.AssistantServiceClient.stream_assist

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient

CmekConfigServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.cmek_config_service.transports.base.CmekConfigServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.cmek_config_service.transports.base.CmekConfigServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the cmek config service async client.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.cmek_config_path

cmek_config_path(project: str, location: str) -> str

Returns a fully-qualified cmek_config string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.cmek_config_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.crypto_key_versions_path

crypto_key_versions_path(
    project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str

Returns a fully-qualified crypto_key_versions string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.crypto_key_versions_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.crypto_keys_path

crypto_keys_path(
    project: str, location: str, key_ring: str, crypto_key: str
) -> str

Returns a fully-qualified crypto_keys string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.crypto_keys_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.delete_cmek_config

delete_cmek_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.cmek_config_service.DeleteCmekConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

De-provisions a CmekConfig.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.delete_cmek_config

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.get_cmek_config

get_cmek_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.cmek_config_service.GetCmekConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.cmek_config_service.CmekConfig

Gets the xref_CmekConfig.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.get_cmek_config

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.cmek_config_service.transports.base.CmekConfigServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.list_cmek_configs

list_cmek_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.cmek_config_service.ListCmekConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.cmek_config_service.ListCmekConfigsResponse

Lists all the xref_CmekConfigs with the project.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.list_cmek_configs

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.location_path

location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.location_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_cmek_config_path

parse_cmek_config_path(path: str) -> typing.Dict[str, str]

Parses a cmek_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_cmek_config_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_crypto_key_versions_path

parse_crypto_key_versions_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key_versions path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_crypto_key_versions_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_crypto_keys_path

parse_crypto_keys_path(path: str) -> typing.Dict[str, str]

Parses a crypto_keys path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_crypto_keys_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_location_path

parse_location_path(path: str) -> typing.Dict[str, str]

Parses a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.parse_location_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.update_cmek_config

update_cmek_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.cmek_config_service.UpdateCmekConfigRequest,
            dict,
        ]
    ] = None,
    *,
    config: typing.Optional[
        google.cloud.discoveryengine_v1.types.cmek_config_service.CmekConfig
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Provisions a CMEK key for use in a location of a customer's project.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceAsyncClient.update_cmek_config

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient

CmekConfigServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.cmek_config_service.transports.base.CmekConfigServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.cmek_config_service.transports.base.CmekConfigServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the cmek config service client.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.exit

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.cmek_config_path

cmek_config_path(project: str, location: str) -> str

Returns a fully-qualified cmek_config string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.cmek_config_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.crypto_key_versions_path

crypto_key_versions_path(
    project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str

Returns a fully-qualified crypto_key_versions string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.crypto_key_versions_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.crypto_keys_path

crypto_keys_path(
    project: str, location: str, key_ring: str, crypto_key: str
) -> str

Returns a fully-qualified crypto_keys string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.crypto_keys_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.delete_cmek_config

delete_cmek_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.cmek_config_service.DeleteCmekConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

De-provisions a CmekConfig.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.delete_cmek_config

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.get_cmek_config

get_cmek_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.cmek_config_service.GetCmekConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.cmek_config_service.CmekConfig

Gets the xref_CmekConfig.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.get_cmek_config

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.get_operation

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.list_cmek_configs

list_cmek_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.cmek_config_service.ListCmekConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.cmek_config_service.ListCmekConfigsResponse

Lists all the xref_CmekConfigs with the project.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.list_cmek_configs

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.list_operations

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.location_path

location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.location_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_cmek_config_path

parse_cmek_config_path(path: str) -> typing.Dict[str, str]

Parses a cmek_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_cmek_config_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_crypto_key_versions_path

parse_crypto_key_versions_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key_versions path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_crypto_key_versions_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_crypto_keys_path

parse_crypto_keys_path(path: str) -> typing.Dict[str, str]

Parses a crypto_keys path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_crypto_keys_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_location_path

parse_location_path(path: str) -> typing.Dict[str, str]

Parses a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.parse_location_path

google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.update_cmek_config

update_cmek_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.cmek_config_service.UpdateCmekConfigRequest,
            dict,
        ]
    ] = None,
    *,
    config: typing.Optional[
        google.cloud.discoveryengine_v1.types.cmek_config_service.CmekConfig
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Provisions a CMEK key for use in a location of a customer's project.

See more: google.cloud.discoveryengine_v1.services.cmek_config_service.CmekConfigServiceClient.update_cmek_config

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient

CompletionServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.completion_service.transports.base.CompletionServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.completion_service.transports.base.CompletionServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the completion service async client.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.complete_query

complete_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.completion_service.CompleteQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.completion_service.CompleteQueryResponse

Completes the specified user input with keyword suggestions.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.complete_query

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.completion_service.transports.base.CompletionServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.import_completion_suggestions

import_completion_suggestions(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.import_config.ImportCompletionSuggestionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Imports xref_CompletionSuggestions for a DataStore.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.import_completion_suggestions

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.import_suggestion_deny_list_entries

import_suggestion_deny_list_entries(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.import_config.ImportSuggestionDenyListEntriesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Imports all xref_SuggestionDenyListEntry for a DataStore.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.import_suggestion_deny_list_entries

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.purge_completion_suggestions

purge_completion_suggestions(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.purge_config.PurgeCompletionSuggestionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Permanently deletes all xref_CompletionSuggestions for a DataStore.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.purge_completion_suggestions

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.purge_suggestion_deny_list_entries

purge_suggestion_deny_list_entries(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.purge_config.PurgeSuggestionDenyListEntriesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Permanently deletes all xref_SuggestionDenyListEntry for a DataStore.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.purge_suggestion_deny_list_entries

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient

CompletionServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.completion_service.transports.base.CompletionServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.completion_service.transports.base.CompletionServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the completion service client.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.exit

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.complete_query

complete_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.completion_service.CompleteQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.completion_service.CompleteQueryResponse

Completes the specified user input with keyword suggestions.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.complete_query

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.get_operation

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.import_completion_suggestions

import_completion_suggestions(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.import_config.ImportCompletionSuggestionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Imports xref_CompletionSuggestions for a DataStore.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.import_completion_suggestions

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.import_suggestion_deny_list_entries

import_suggestion_deny_list_entries(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.import_config.ImportSuggestionDenyListEntriesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Imports all xref_SuggestionDenyListEntry for a DataStore.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.import_suggestion_deny_list_entries

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.list_operations

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.purge_completion_suggestions

purge_completion_suggestions(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.purge_config.PurgeCompletionSuggestionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Permanently deletes all xref_CompletionSuggestions for a DataStore.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.purge_completion_suggestions

google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.purge_suggestion_deny_list_entries

purge_suggestion_deny_list_entries(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.purge_config.PurgeSuggestionDenyListEntriesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Permanently deletes all xref_SuggestionDenyListEntry for a DataStore.

See more: google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.purge_suggestion_deny_list_entries

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient

ControlServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.control_service.transports.base.ControlServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.control_service.transports.base.ControlServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the control service async client.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.control_path

control_path(project: str, location: str, data_store: str, control: str) -> str

Returns a fully-qualified control string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.control_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.create_control

create_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.CreateControlRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    control: typing.Optional[
        google.cloud.discoveryengine_v1.types.control.Control
    ] = None,
    control_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.control.Control

Creates a Control.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.create_control

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.delete_control

delete_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.DeleteControlRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Control.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.delete_control

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.document_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.get_control

get_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.GetControlRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.control.Control

Gets a Control.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.get_control

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.control_service.transports.base.ControlServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.list_controls

list_controls(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.ListControlsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.control_service.pagers.ListControlsAsyncPager
)

Lists all Controls by their parent xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.list_controls

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_control_path

parse_control_path(path: str) -> typing.Dict[str, str]

Parses a control path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_control_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.parse_document_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.update_control

update_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.UpdateControlRequest,
            dict,
        ]
    ] = None,
    *,
    control: typing.Optional[
        google.cloud.discoveryengine_v1.types.control.Control
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.control.Control

Updates a Control.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.update_control

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient

ControlServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.control_service.transports.base.ControlServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.control_service.transports.base.ControlServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the control service client.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.exit

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.control_path

control_path(project: str, location: str, data_store: str, control: str) -> str

Returns a fully-qualified control string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.control_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.create_control

create_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.CreateControlRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    control: typing.Optional[
        google.cloud.discoveryengine_v1.types.control.Control
    ] = None,
    control_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.control.Control

Creates a Control.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.create_control

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.delete_control

delete_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.DeleteControlRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Control.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.delete_control

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.document_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.get_control

get_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.GetControlRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.control.Control

Gets a Control.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.get_control

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.get_operation

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.list_controls

list_controls(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.ListControlsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.services.control_service.pagers.ListControlsPager

Lists all Controls by their parent xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.list_controls

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.list_operations

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_control_path

parse_control_path(path: str) -> typing.Dict[str, str]

Parses a control path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_control_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.parse_document_path

google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.update_control

update_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.control_service.UpdateControlRequest,
            dict,
        ]
    ] = None,
    *,
    control: typing.Optional[
        google.cloud.discoveryengine_v1.types.control.Control
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.control.Control

Updates a Control.

See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.update_control

google.cloud.discoveryengine_v1.services.control_service.pagers.ListControlsAsyncPager

ListControlsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.control_service.ListControlsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.control_service.ListControlsRequest,
    response: google.cloud.discoveryengine_v1.types.control_service.ListControlsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.control_service.pagers.ListControlsAsyncPager

google.cloud.discoveryengine_v1.services.control_service.pagers.ListControlsPager

ListControlsPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.control_service.ListControlsResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.control_service.ListControlsRequest,
    response: google.cloud.discoveryengine_v1.types.control_service.ListControlsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.control_service.pagers.ListControlsPager

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient

ConversationalSearchServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the conversational search service async client.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.answer_path

answer_path(
    project: str, location: str, data_store: str, session: str, answer: str
) -> str

Returns a fully-qualified answer string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.answer_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.answer_query

answer_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryResponse
)

Answer query method.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.answer_query

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.assist_answer_path

assist_answer_path(
    project: str,
    location: str,
    collection: str,
    engine: str,
    session: str,
    assist_answer: str,
) -> str

Returns a fully-qualified assist_answer string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.assist_answer_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.chunk_path

chunk_path(
    project: str, location: str, data_store: str, branch: str, document: str, chunk: str
) -> str

Returns a fully-qualified chunk string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.chunk_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.conversation_path

conversation_path(
    project: str, location: str, data_store: str, conversation: str
) -> str

Returns a fully-qualified conversation string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.conversation_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.converse_conversation

converse_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ConverseConversationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    query: typing.Optional[
        google.cloud.discoveryengine_v1.types.conversation.TextInput
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.conversational_search_service.ConverseConversationResponse
)

Converses a conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.converse_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.create_conversation

create_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.CreateConversationRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    conversation: typing.Optional[
        google.cloud.discoveryengine_v1.types.conversation.Conversation
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation

Creates a Conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.create_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.create_session

create_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.CreateSessionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    session: typing.Optional[
        google.cloud.discoveryengine_v1.types.session.Session
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Creates a Session.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.create_session

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.delete_conversation

delete_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.DeleteConversationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.delete_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.delete_session

delete_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.DeleteSessionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Session.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.delete_session

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.document_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_answer

get_answer(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.GetAnswerRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.answer.Answer

Gets a Answer.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_answer

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_conversation

get_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.GetConversationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation

Gets a Conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_session

get_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.GetSessionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Gets a Session.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_session

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_conversations

list_conversations(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListConversationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListConversationsAsyncPager
)

Lists all Conversations by their parent xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_conversations

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_sessions

list_sessions(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListSessionsAsyncPager
)

Lists all Sessions by their parent xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_sessions

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_answer_path

parse_answer_path(path: str) -> typing.Dict[str, str]

Parses a answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_answer_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_assist_answer_path

parse_assist_answer_path(path: str) -> typing.Dict[str, str]

Parses a assist_answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_assist_answer_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_chunk_path

parse_chunk_path(path: str) -> typing.Dict[str, str]

Parses a chunk path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_chunk_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_conversation_path

parse_conversation_path(path: str) -> typing.Dict[str, str]

Parses a conversation path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_conversation_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_document_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.parse_session_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.serving_config_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.session_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.stream_answer_query

stream_answer_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> typing.Awaitable[
    typing.AsyncIterable[
        google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryResponse
    ]
]

Answer query method (streaming).

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.stream_answer_query

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.update_conversation

update_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.UpdateConversationRequest,
            dict,
        ]
    ] = None,
    *,
    conversation: typing.Optional[
        google.cloud.discoveryengine_v1.types.conversation.Conversation
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation

Updates a Conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.update_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.update_session

update_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.UpdateSessionRequest,
            dict,
        ]
    ] = None,
    *,
    session: typing.Optional[
        google.cloud.discoveryengine_v1.types.session.Session
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Updates a Session.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.update_session

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient

ConversationalSearchServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the conversational search service client.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.exit

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.answer_path

answer_path(
    project: str, location: str, data_store: str, session: str, answer: str
) -> str

Returns a fully-qualified answer string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.answer_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.answer_query

answer_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryResponse
)

Answer query method.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.answer_query

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.assist_answer_path

assist_answer_path(
    project: str,
    location: str,
    collection: str,
    engine: str,
    session: str,
    assist_answer: str,
) -> str

Returns a fully-qualified assist_answer string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.assist_answer_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.chunk_path

chunk_path(
    project: str, location: str, data_store: str, branch: str, document: str, chunk: str
) -> str

Returns a fully-qualified chunk string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.chunk_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.conversation_path

conversation_path(
    project: str, location: str, data_store: str, conversation: str
) -> str

Returns a fully-qualified conversation string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.conversation_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.converse_conversation

converse_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ConverseConversationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    query: typing.Optional[
        google.cloud.discoveryengine_v1.types.conversation.TextInput
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.conversational_search_service.ConverseConversationResponse
)

Converses a conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.converse_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.create_conversation

create_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.CreateConversationRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    conversation: typing.Optional[
        google.cloud.discoveryengine_v1.types.conversation.Conversation
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation

Creates a Conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.create_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.create_session

create_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.CreateSessionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    session: typing.Optional[
        google.cloud.discoveryengine_v1.types.session.Session
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Creates a Session.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.create_session

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.delete_conversation

delete_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.DeleteConversationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.delete_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.delete_session

delete_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.DeleteSessionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Session.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.delete_session

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.document_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_answer

get_answer(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.GetAnswerRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.answer.Answer

Gets a Answer.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_answer

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_conversation

get_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.GetConversationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation

Gets a Conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_operation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_session

get_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.GetSessionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Gets a Session.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.get_session

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.list_conversations

list_conversations(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListConversationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListConversationsPager
)

Lists all Conversations by their parent xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.list_conversations

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.list_operations

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.list_sessions

list_sessions(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListSessionsPager
)

Lists all Sessions by their parent xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.list_sessions

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_answer_path

parse_answer_path(path: str) -> typing.Dict[str, str]

Parses a answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_answer_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_assist_answer_path

parse_assist_answer_path(path: str) -> typing.Dict[str, str]

Parses a assist_answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_assist_answer_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_chunk_path

parse_chunk_path(path: str) -> typing.Dict[str, str]

Parses a chunk path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_chunk_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_conversation_path

parse_conversation_path(path: str) -> typing.Dict[str, str]

Parses a conversation path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_conversation_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_document_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.parse_session_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.serving_config_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.session_path

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.stream_answer_query

stream_answer_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> typing.Iterable[
    google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryResponse
]

Answer query method (streaming).

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.stream_answer_query

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.update_conversation

update_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.UpdateConversationRequest,
            dict,
        ]
    ] = None,
    *,
    conversation: typing.Optional[
        google.cloud.discoveryengine_v1.types.conversation.Conversation
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation

Updates a Conversation.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.update_conversation

google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.update_session

update_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.UpdateSessionRequest,
            dict,
        ]
    ] = None,
    *,
    session: typing.Optional[
        google.cloud.discoveryengine_v1.types.session.Session
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Updates a Session.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.update_session

google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListConversationsAsyncPager

ListConversationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListConversationsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.conversational_search_service.ListConversationsRequest,
    response: google.cloud.discoveryengine_v1.types.conversational_search_service.ListConversationsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListConversationsAsyncPager

google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListConversationsPager

ListConversationsPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.conversational_search_service.ListConversationsResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.conversational_search_service.ListConversationsRequest,
    response: google.cloud.discoveryengine_v1.types.conversational_search_service.ListConversationsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListConversationsPager

google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListSessionsAsyncPager

ListSessionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsRequest,
    response: google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListSessionsAsyncPager

google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListSessionsPager

ListSessionsPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsRequest,
    response: google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListSessionsPager

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient

DataStoreServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.data_store_service.transports.base.DataStoreServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.data_store_service.transports.base.DataStoreServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the data store service async client.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.cmek_config_path

cmek_config_path(project: str, location: str) -> str

Returns a fully-qualified cmek_config string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.cmek_config_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.collection_path

collection_path(project: str, location: str, collection: str) -> str

Returns a fully-qualified collection string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.collection_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.create_data_store

create_data_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.CreateDataStoreRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    data_store: typing.Optional[
        google.cloud.discoveryengine_v1.types.data_store.DataStore
    ] = None,
    data_store_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.create_data_store

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.crypto_key_versions_path

crypto_key_versions_path(
    project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str

Returns a fully-qualified crypto_key_versions string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.crypto_key_versions_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.crypto_keys_path

crypto_keys_path(
    project: str, location: str, key_ring: str, crypto_key: str
) -> str

Returns a fully-qualified crypto_keys string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.crypto_keys_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.delete_data_store

delete_data_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.DeleteDataStoreRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.delete_data_store

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.document_processing_config_path

document_processing_config_path(
    project: str, location: str, data_store: str
) -> str

Returns a fully-qualified document_processing_config string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.document_processing_config_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.get_data_store

get_data_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.GetDataStoreRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.data_store.DataStore

Gets a xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.get_data_store

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.data_store_service.transports.base.DataStoreServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.identity_mapping_store_path

identity_mapping_store_path(
    project: str, location: str, identity_mapping_store: str
) -> str

Returns a fully-qualified identity_mapping_store string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.identity_mapping_store_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.list_data_stores

list_data_stores(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.ListDataStoresRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresAsyncPager
)

Lists all the xref_DataStores associated with the project.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.list_data_stores

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_cmek_config_path

parse_cmek_config_path(path: str) -> typing.Dict[str, str]

Parses a cmek_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_cmek_config_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_collection_path

parse_collection_path(path: str) -> typing.Dict[str, str]

Parses a collection path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_collection_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_crypto_key_versions_path

parse_crypto_key_versions_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key_versions path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_crypto_key_versions_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_crypto_keys_path

parse_crypto_keys_path(path: str) -> typing.Dict[str, str]

Parses a crypto_keys path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_crypto_keys_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_document_processing_config_path

parse_document_processing_config_path(path: str) -> typing.Dict[str, str]

Parses a document_processing_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_document_processing_config_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_identity_mapping_store_path

parse_identity_mapping_store_path(path: str) -> typing.Dict[str, str]

Parses a identity_mapping_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_identity_mapping_store_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_schema_path

parse_schema_path(path: str) -> typing.Dict[str, str]

Parses a schema path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.parse_schema_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.schema_path

schema_path(project: str, location: str, data_store: str, schema: str) -> str

Returns a fully-qualified schema string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.schema_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.update_data_store

update_data_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.UpdateDataStoreRequest,
            dict,
        ]
    ] = None,
    *,
    data_store: typing.Optional[
        google.cloud.discoveryengine_v1.types.data_store.DataStore
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.data_store.DataStore

Updates a xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.update_data_store

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient

DataStoreServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.data_store_service.transports.base.DataStoreServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.data_store_service.transports.base.DataStoreServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the data store service client.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.exit

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.cmek_config_path

cmek_config_path(project: str, location: str) -> str

Returns a fully-qualified cmek_config string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.cmek_config_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.collection_path

collection_path(project: str, location: str, collection: str) -> str

Returns a fully-qualified collection string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.collection_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.create_data_store

create_data_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.CreateDataStoreRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    data_store: typing.Optional[
        google.cloud.discoveryengine_v1.types.data_store.DataStore
    ] = None,
    data_store_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.create_data_store

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.crypto_key_versions_path

crypto_key_versions_path(
    project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str

Returns a fully-qualified crypto_key_versions string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.crypto_key_versions_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.crypto_keys_path

crypto_keys_path(
    project: str, location: str, key_ring: str, crypto_key: str
) -> str

Returns a fully-qualified crypto_keys string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.crypto_keys_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.delete_data_store

delete_data_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.DeleteDataStoreRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.delete_data_store

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.document_processing_config_path

document_processing_config_path(
    project: str, location: str, data_store: str
) -> str

Returns a fully-qualified document_processing_config string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.document_processing_config_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.get_data_store

get_data_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.GetDataStoreRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.data_store.DataStore

Gets a xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.get_data_store

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.get_operation

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.identity_mapping_store_path

identity_mapping_store_path(
    project: str, location: str, identity_mapping_store: str
) -> str

Returns a fully-qualified identity_mapping_store string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.identity_mapping_store_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.list_data_stores

list_data_stores(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.ListDataStoresRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresPager
)

Lists all the xref_DataStores associated with the project.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.list_data_stores

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.list_operations

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_cmek_config_path

parse_cmek_config_path(path: str) -> typing.Dict[str, str]

Parses a cmek_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_cmek_config_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_collection_path

parse_collection_path(path: str) -> typing.Dict[str, str]

Parses a collection path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_collection_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_crypto_key_versions_path

parse_crypto_key_versions_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key_versions path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_crypto_key_versions_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_crypto_keys_path

parse_crypto_keys_path(path: str) -> typing.Dict[str, str]

Parses a crypto_keys path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_crypto_keys_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_document_processing_config_path

parse_document_processing_config_path(path: str) -> typing.Dict[str, str]

Parses a document_processing_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_document_processing_config_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_identity_mapping_store_path

parse_identity_mapping_store_path(path: str) -> typing.Dict[str, str]

Parses a identity_mapping_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_identity_mapping_store_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_schema_path

parse_schema_path(path: str) -> typing.Dict[str, str]

Parses a schema path into its component segments.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.parse_schema_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.schema_path

schema_path(project: str, location: str, data_store: str, schema: str) -> str

Returns a fully-qualified schema string.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.schema_path

google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.update_data_store

update_data_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.data_store_service.UpdateDataStoreRequest,
            dict,
        ]
    ] = None,
    *,
    data_store: typing.Optional[
        google.cloud.discoveryengine_v1.types.data_store.DataStore
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.data_store.DataStore

Updates a xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.update_data_store

google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresAsyncPager

ListDataStoresAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.data_store_service.ListDataStoresResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.data_store_service.ListDataStoresRequest,
    response: google.cloud.discoveryengine_v1.types.data_store_service.ListDataStoresResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresAsyncPager

google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresPager

ListDataStoresPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.data_store_service.ListDataStoresResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.data_store_service.ListDataStoresRequest,
    response: google.cloud.discoveryengine_v1.types.data_store_service.ListDataStoresResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresPager

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient

DocumentServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.document_service.transports.base.DocumentServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.document_service.transports.base.DocumentServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the document service async client.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.batch_get_documents_metadata

batch_get_documents_metadata(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.BatchGetDocumentsMetadataRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.document_service.BatchGetDocumentsMetadataResponse
)

Gets index freshness metadata for xref_Documents.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.batch_get_documents_metadata

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.branch_path

branch_path(project: str, location: str, data_store: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.branch_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.create_document

create_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.CreateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    document: typing.Optional[
        google.cloud.discoveryengine_v1.types.document.Document
    ] = None,
    document_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.document.Document

Creates a xref_Document.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.create_document

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.delete_document

delete_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.DeleteDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a xref_Document.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.delete_document

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.document_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.fhir_resource_path

fhir_resource_path(
    project: str,
    location: str,
    dataset: str,
    fhir_store: str,
    resource_type: str,
    fhir_resource_id: str,
) -> str

Returns a fully-qualified fhir_resource string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.fhir_resource_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.fhir_store_path

fhir_store_path(project: str, location: str, dataset: str, fhir_store: str) -> str

Returns a fully-qualified fhir_store string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.fhir_store_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.document.Document

Gets a xref_Document.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.get_document

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.document_service.transports.base.DocumentServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.import_documents

import_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.import_config.ImportDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Bulk import of multiple xref_Documents.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.import_documents

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.list_documents

list_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.ListDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.document_service.pagers.ListDocumentsAsyncPager
)

Gets a list of xref_Documents.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.list_documents

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_branch_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_document_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_fhir_resource_path

parse_fhir_resource_path(path: str) -> typing.Dict[str, str]

Parses a fhir_resource path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_fhir_resource_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_fhir_store_path

parse_fhir_store_path(path: str) -> typing.Dict[str, str]

Parses a fhir_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.parse_fhir_store_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.purge_documents

purge_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.purge_config.PurgeDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Permanently deletes all selected xref_Documents in a branch.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.purge_documents

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.update_document

update_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.UpdateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    document: typing.Optional[
        google.cloud.discoveryengine_v1.types.document.Document
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.document.Document

Updates a xref_Document.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.update_document

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient

DocumentServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.document_service.transports.base.DocumentServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.document_service.transports.base.DocumentServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the document service client.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.exit

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.batch_get_documents_metadata

batch_get_documents_metadata(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.BatchGetDocumentsMetadataRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.document_service.BatchGetDocumentsMetadataResponse
)

Gets index freshness metadata for xref_Documents.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.batch_get_documents_metadata

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.branch_path

branch_path(project: str, location: str, data_store: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.branch_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.create_document

create_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.CreateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    document: typing.Optional[
        google.cloud.discoveryengine_v1.types.document.Document
    ] = None,
    document_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.document.Document

Creates a xref_Document.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.create_document

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.delete_document

delete_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.DeleteDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a xref_Document.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.delete_document

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.document_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.fhir_resource_path

fhir_resource_path(
    project: str,
    location: str,
    dataset: str,
    fhir_store: str,
    resource_type: str,
    fhir_resource_id: str,
) -> str

Returns a fully-qualified fhir_resource string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.fhir_resource_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.fhir_store_path

fhir_store_path(project: str, location: str, dataset: str, fhir_store: str) -> str

Returns a fully-qualified fhir_store string.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.fhir_store_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.document.Document

Gets a xref_Document.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.get_document

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.get_operation

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.import_documents

import_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.import_config.ImportDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Bulk import of multiple xref_Documents.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.import_documents

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.list_documents

list_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.ListDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.document_service.pagers.ListDocumentsPager
)

Gets a list of xref_Documents.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.list_documents

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.list_operations

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_branch_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_document_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_fhir_resource_path

parse_fhir_resource_path(path: str) -> typing.Dict[str, str]

Parses a fhir_resource path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_fhir_resource_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_fhir_store_path

parse_fhir_store_path(path: str) -> typing.Dict[str, str]

Parses a fhir_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.parse_fhir_store_path

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.purge_documents

purge_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.purge_config.PurgeDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Permanently deletes all selected xref_Documents in a branch.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.purge_documents

google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.update_document

update_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.document_service.UpdateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    document: typing.Optional[
        google.cloud.discoveryengine_v1.types.document.Document
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.document.Document

Updates a xref_Document.

See more: google.cloud.discoveryengine_v1.services.document_service.DocumentServiceClient.update_document

google.cloud.discoveryengine_v1.services.document_service.pagers.ListDocumentsAsyncPager

ListDocumentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.document_service.ListDocumentsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.document_service.ListDocumentsRequest,
    response: google.cloud.discoveryengine_v1.types.document_service.ListDocumentsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.document_service.pagers.ListDocumentsAsyncPager

google.cloud.discoveryengine_v1.services.document_service.pagers.ListDocumentsPager

ListDocumentsPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.document_service.ListDocumentsResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.document_service.ListDocumentsRequest,
    response: google.cloud.discoveryengine_v1.types.document_service.ListDocumentsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.document_service.pagers.ListDocumentsPager

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient

EngineServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.engine_service.transports.base.EngineServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.engine_service.transports.base.EngineServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the engine service async client.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.collection_path

collection_path(project: str, location: str, collection: str) -> str

Returns a fully-qualified collection string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.collection_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.create_engine

create_engine(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.CreateEngineRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    engine: typing.Optional[google.cloud.discoveryengine_v1.types.engine.Engine] = None,
    engine_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a xref_Engine.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.create_engine

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.delete_engine

delete_engine(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.DeleteEngineRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a xref_Engine.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.delete_engine

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.engine_path

engine_path(project: str, location: str, collection: str, engine: str) -> str

Returns a fully-qualified engine string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.engine_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.get_engine

get_engine(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.GetEngineRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.engine.Engine

Gets a xref_Engine.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.get_engine

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.engine_service.transports.base.EngineServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.list_engines

list_engines(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.ListEnginesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.engine_service.pagers.ListEnginesAsyncPager
)

Lists all the xref_Engines associated with the project.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.list_engines

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_collection_path

parse_collection_path(path: str) -> typing.Dict[str, str]

Parses a collection path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_collection_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_engine_path

parse_engine_path(path: str) -> typing.Dict[str, str]

Parses a engine path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.parse_engine_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.update_engine

update_engine(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.UpdateEngineRequest,
            dict,
        ]
    ] = None,
    *,
    engine: typing.Optional[google.cloud.discoveryengine_v1.types.engine.Engine] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.engine.Engine

Updates an xref_Engine.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.update_engine

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient

EngineServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.engine_service.transports.base.EngineServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.engine_service.transports.base.EngineServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the engine service client.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.exit

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.collection_path

collection_path(project: str, location: str, collection: str) -> str

Returns a fully-qualified collection string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.collection_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.create_engine

create_engine(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.CreateEngineRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    engine: typing.Optional[google.cloud.discoveryengine_v1.types.engine.Engine] = None,
    engine_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a xref_Engine.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.create_engine

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.delete_engine

delete_engine(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.DeleteEngineRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a xref_Engine.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.delete_engine

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.engine_path

engine_path(project: str, location: str, collection: str, engine: str) -> str

Returns a fully-qualified engine string.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.engine_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.get_engine

get_engine(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.GetEngineRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.engine.Engine

Gets a xref_Engine.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.get_engine

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.get_operation

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.list_engines

list_engines(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.ListEnginesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.services.engine_service.pagers.ListEnginesPager

Lists all the xref_Engines associated with the project.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.list_engines

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.list_operations

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_collection_path

parse_collection_path(path: str) -> typing.Dict[str, str]

Parses a collection path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_collection_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_engine_path

parse_engine_path(path: str) -> typing.Dict[str, str]

Parses a engine path into its component segments.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.parse_engine_path

google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.update_engine

update_engine(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.engine_service.UpdateEngineRequest,
            dict,
        ]
    ] = None,
    *,
    engine: typing.Optional[google.cloud.discoveryengine_v1.types.engine.Engine] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.engine.Engine

Updates an xref_Engine.

See more: google.cloud.discoveryengine_v1.services.engine_service.EngineServiceClient.update_engine

google.cloud.discoveryengine_v1.services.engine_service.pagers.ListEnginesAsyncPager

ListEnginesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.engine_service.ListEnginesResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.engine_service.ListEnginesRequest,
    response: google.cloud.discoveryengine_v1.types.engine_service.ListEnginesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.engine_service.pagers.ListEnginesAsyncPager

google.cloud.discoveryengine_v1.services.engine_service.pagers.ListEnginesPager

ListEnginesPager(
    method: typing.Callable[
        [...], google.cloud.discoveryengine_v1.types.engine_service.ListEnginesResponse
    ],
    request: google.cloud.discoveryengine_v1.types.engine_service.ListEnginesRequest,
    response: google.cloud.discoveryengine_v1.types.engine_service.ListEnginesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.engine_service.pagers.ListEnginesPager

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient

GroundedGenerationServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the grounded generation service async client.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.check_grounding

check_grounding(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.grounded_generation_service.CheckGroundingRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.grounded_generation_service.CheckGroundingResponse
)

Performs a grounding check.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.check_grounding

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.generate_grounded_content

generate_grounded_content(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentResponse
)

Generates grounded content.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.generate_grounded_content

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.grounding_config_path

grounding_config_path(project: str, location: str, grounding_config: str) -> str

Returns a fully-qualified grounding_config string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.grounding_config_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.location_path

location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.location_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_grounding_config_path

parse_grounding_config_path(path: str) -> typing.Dict[str, str]

Parses a grounding_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_grounding_config_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_location_path

parse_location_path(path: str) -> typing.Dict[str, str]

Parses a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_location_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.serving_config_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.stream_generate_grounded_content

stream_generate_grounded_content(
    requests: typing.Optional[
        typing.AsyncIterator[
            google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentRequest
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> typing.Awaitable[
    typing.AsyncIterable[
        google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentResponse
    ]
]

Generates grounded content in a streaming fashion.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.stream_generate_grounded_content

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient

GroundedGenerationServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the grounded generation service client.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.exit

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.check_grounding

check_grounding(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.grounded_generation_service.CheckGroundingRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.grounded_generation_service.CheckGroundingResponse
)

Performs a grounding check.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.check_grounding

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.generate_grounded_content

generate_grounded_content(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentResponse
)

Generates grounded content.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.generate_grounded_content

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.get_operation

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.grounding_config_path

grounding_config_path(project: str, location: str, grounding_config: str) -> str

Returns a fully-qualified grounding_config string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.grounding_config_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.list_operations

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.location_path

location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.location_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_grounding_config_path

parse_grounding_config_path(path: str) -> typing.Dict[str, str]

Parses a grounding_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_grounding_config_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_location_path

parse_location_path(path: str) -> typing.Dict[str, str]

Parses a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_location_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.serving_config_path

google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.stream_generate_grounded_content

stream_generate_grounded_content(
    requests: typing.Optional[
        typing.Iterator[
            google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentRequest
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> typing.Iterable[
    google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentResponse
]

Generates grounded content in a streaming fashion.

See more: google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.stream_generate_grounded_content

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient

IdentityMappingStoreServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.identity_mapping_store_service.transports.base.IdentityMappingStoreServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.identity_mapping_store_service.transports.base.IdentityMappingStoreServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the identity mapping store service async client.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.cmek_config_path

cmek_config_path(project: str, location: str) -> str

Returns a fully-qualified cmek_config string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.cmek_config_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.create_identity_mapping_store

create_identity_mapping_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.CreateIdentityMappingStoreRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    identity_mapping_store: typing.Optional[
        google.cloud.discoveryengine_v1.types.identity_mapping_store.IdentityMappingStore
    ] = None,
    identity_mapping_store_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.identity_mapping_store.IdentityMappingStore

Creates a new Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.create_identity_mapping_store

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.crypto_key_versions_path

crypto_key_versions_path(
    project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str

Returns a fully-qualified crypto_key_versions string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.crypto_key_versions_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.crypto_keys_path

crypto_keys_path(
    project: str, location: str, key_ring: str, crypto_key: str
) -> str

Returns a fully-qualified crypto_keys string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.crypto_keys_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.delete_identity_mapping_store

delete_identity_mapping_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.DeleteIdentityMappingStoreRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes the Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.delete_identity_mapping_store

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.get_identity_mapping_store

get_identity_mapping_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.GetIdentityMappingStoreRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.identity_mapping_store.IdentityMappingStore

Gets the Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.get_identity_mapping_store

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.identity_mapping_store_service.transports.base.IdentityMappingStoreServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.identity_mapping_store_path

identity_mapping_store_path(
    project: str, location: str, identity_mapping_store: str
) -> str

Returns a fully-qualified identity_mapping_store string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.identity_mapping_store_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.import_identity_mappings

import_identity_mappings(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ImportIdentityMappingsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Imports a list of Identity Mapping Entries to an Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.import_identity_mappings

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.list_identity_mapping_stores

list_identity_mapping_stores(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingStoresRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingStoresAsyncPager
)

Lists all Identity Mapping Stores.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.list_identity_mapping_stores

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.list_identity_mappings

list_identity_mappings(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingsAsyncPager
)

Lists Identity Mappings in an Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.list_identity_mappings

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.location_path

location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.location_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_cmek_config_path

parse_cmek_config_path(path: str) -> typing.Dict[str, str]

Parses a cmek_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_cmek_config_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_crypto_key_versions_path

parse_crypto_key_versions_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key_versions path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_crypto_key_versions_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_crypto_keys_path

parse_crypto_keys_path(path: str) -> typing.Dict[str, str]

Parses a crypto_keys path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_crypto_keys_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_identity_mapping_store_path

parse_identity_mapping_store_path(path: str) -> typing.Dict[str, str]

Parses a identity_mapping_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_identity_mapping_store_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_location_path

parse_location_path(path: str) -> typing.Dict[str, str]

Parses a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.parse_location_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.purge_identity_mappings

purge_identity_mappings(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.PurgeIdentityMappingsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceAsyncClient.purge_identity_mappings

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient

IdentityMappingStoreServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.identity_mapping_store_service.transports.base.IdentityMappingStoreServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.identity_mapping_store_service.transports.base.IdentityMappingStoreServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the identity mapping store service client.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.exit

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.cmek_config_path

cmek_config_path(project: str, location: str) -> str

Returns a fully-qualified cmek_config string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.cmek_config_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.create_identity_mapping_store

create_identity_mapping_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.CreateIdentityMappingStoreRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    identity_mapping_store: typing.Optional[
        google.cloud.discoveryengine_v1.types.identity_mapping_store.IdentityMappingStore
    ] = None,
    identity_mapping_store_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.identity_mapping_store.IdentityMappingStore

Creates a new Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.create_identity_mapping_store

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.crypto_key_versions_path

crypto_key_versions_path(
    project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str

Returns a fully-qualified crypto_key_versions string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.crypto_key_versions_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.crypto_keys_path

crypto_keys_path(
    project: str, location: str, key_ring: str, crypto_key: str
) -> str

Returns a fully-qualified crypto_keys string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.crypto_keys_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.delete_identity_mapping_store

delete_identity_mapping_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.DeleteIdentityMappingStoreRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes the Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.delete_identity_mapping_store

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.get_identity_mapping_store

get_identity_mapping_store(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.GetIdentityMappingStoreRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.identity_mapping_store.IdentityMappingStore

Gets the Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.get_identity_mapping_store

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.get_operation

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.identity_mapping_store_path

identity_mapping_store_path(
    project: str, location: str, identity_mapping_store: str
) -> str

Returns a fully-qualified identity_mapping_store string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.identity_mapping_store_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.import_identity_mappings

import_identity_mappings(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ImportIdentityMappingsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Imports a list of Identity Mapping Entries to an Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.import_identity_mappings

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.list_identity_mapping_stores

list_identity_mapping_stores(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingStoresRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingStoresPager
)

Lists all Identity Mapping Stores.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.list_identity_mapping_stores

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.list_identity_mappings

list_identity_mappings(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingsPager
)

Lists Identity Mappings in an Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.list_identity_mappings

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.list_operations

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.location_path

location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.location_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_cmek_config_path

parse_cmek_config_path(path: str) -> typing.Dict[str, str]

Parses a cmek_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_cmek_config_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_crypto_key_versions_path

parse_crypto_key_versions_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key_versions path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_crypto_key_versions_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_crypto_keys_path

parse_crypto_keys_path(path: str) -> typing.Dict[str, str]

Parses a crypto_keys path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_crypto_keys_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_identity_mapping_store_path

parse_identity_mapping_store_path(path: str) -> typing.Dict[str, str]

Parses a identity_mapping_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_identity_mapping_store_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_location_path

parse_location_path(path: str) -> typing.Dict[str, str]

Parses a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.parse_location_path

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.purge_identity_mappings

purge_identity_mappings(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.PurgeIdentityMappingsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.IdentityMappingStoreServiceClient.purge_identity_mappings

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingStoresAsyncPager

ListIdentityMappingStoresAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingStoresResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingStoresRequest,
    response: google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingStoresResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingStoresAsyncPager

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingStoresPager

ListIdentityMappingStoresPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingStoresResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingStoresRequest,
    response: google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingStoresResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingStoresPager

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingsAsyncPager

ListIdentityMappingsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingsRequest,
    response: google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingsAsyncPager

google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingsPager

ListIdentityMappingsPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingsResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingsRequest,
    response: google.cloud.discoveryengine_v1.types.identity_mapping_store_service.ListIdentityMappingsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingsPager

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient

ProjectServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.project_service.transports.base.ProjectServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.project_service.transports.base.ProjectServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the project service async client.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.project_service.transports.base.ProjectServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_project_path

parse_project_path(path: str) -> typing.Dict[str, str]

Parses a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.parse_project_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.project_path

project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.project_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.provision_project

provision_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.project_service.ProvisionProjectRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Provisions the project resource.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.provision_project

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient

ProjectServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.project_service.transports.base.ProjectServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.project_service.transports.base.ProjectServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the project service client.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.exit

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.get_operation

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.list_operations

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_project_path

parse_project_path(path: str) -> typing.Dict[str, str]

Parses a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.parse_project_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.project_path

project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.project_path

google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.provision_project

provision_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.project_service.ProvisionProjectRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Provisions the project resource.

See more: google.cloud.discoveryengine_v1.services.project_service.ProjectServiceClient.provision_project

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient

RankServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.rank_service.transports.base.RankServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.rank_service.transports.base.RankServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the rank service async client.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.rank_service.transports.base.RankServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_ranking_config_path

parse_ranking_config_path(path: str) -> typing.Dict[str, str]

Parses a ranking_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.parse_ranking_config_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.rank

rank(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.rank_service.RankRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.rank_service.RankResponse

Ranks a list of text records based on the given input query.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.rank

google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.ranking_config_path

ranking_config_path(project: str, location: str, ranking_config: str) -> str

Returns a fully-qualified ranking_config string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceAsyncClient.ranking_config_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient

RankServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.rank_service.transports.base.RankServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.rank_service.transports.base.RankServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the rank service client.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.exit

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.get_operation

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.list_operations

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_ranking_config_path

parse_ranking_config_path(path: str) -> typing.Dict[str, str]

Parses a ranking_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.parse_ranking_config_path

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.rank

rank(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.rank_service.RankRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.rank_service.RankResponse

Ranks a list of text records based on the given input query.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.rank

google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.ranking_config_path

ranking_config_path(project: str, location: str, ranking_config: str) -> str

Returns a fully-qualified ranking_config string.

See more: google.cloud.discoveryengine_v1.services.rank_service.RankServiceClient.ranking_config_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient

RecommendationServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.recommendation_service.transports.base.RecommendationServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.recommendation_service.transports.base.RecommendationServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the recommendation service async client.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.document_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.engine_path

engine_path(project: str, location: str, collection: str, engine: str) -> str

Returns a fully-qualified engine string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.engine_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.recommendation_service.transports.base.RecommendationServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_document_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_engine_path

parse_engine_path(path: str) -> typing.Dict[str, str]

Parses a engine path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_engine_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.recommend

recommend(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.recommendation_service.RecommendRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.recommendation_service.RecommendResponse

Makes a recommendation, which requires a contextual user event.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.recommend

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.serving_config_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient

RecommendationServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.recommendation_service.transports.base.RecommendationServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.recommendation_service.transports.base.RecommendationServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the recommendation service client.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.exit

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.document_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.engine_path

engine_path(project: str, location: str, collection: str, engine: str) -> str

Returns a fully-qualified engine string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.engine_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.get_operation

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.list_operations

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_document_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_engine_path

parse_engine_path(path: str) -> typing.Dict[str, str]

Parses a engine path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_engine_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.recommend

recommend(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.recommendation_service.RecommendRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.recommendation_service.RecommendResponse

Makes a recommendation, which requires a contextual user event.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.recommend

google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.serving_config_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient

SchemaServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.schema_service.transports.base.SchemaServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.schema_service.transports.base.SchemaServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the schema service async client.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.create_schema

create_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.CreateSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    schema: typing.Optional[google.cloud.discoveryengine_v1.types.schema.Schema] = None,
    schema_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a xref_Schema.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.create_schema

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.delete_schema

delete_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.DeleteSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a xref_Schema.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.delete_schema

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.get_schema

get_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.GetSchemaRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.schema.Schema

Gets a xref_Schema.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.get_schema

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.schema_service.transports.base.SchemaServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.list_schemas

list_schemas(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.ListSchemasRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.schema_service.pagers.ListSchemasAsyncPager
)

Gets a list of xref_Schemas.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.list_schemas

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_schema_path

parse_schema_path(path: str) -> typing.Dict[str, str]

Parses a schema path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.parse_schema_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.schema_path

schema_path(project: str, location: str, data_store: str, schema: str) -> str

Returns a fully-qualified schema string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.schema_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.update_schema

update_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.UpdateSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a xref_Schema.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.update_schema

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient

SchemaServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.schema_service.transports.base.SchemaServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.schema_service.transports.base.SchemaServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the schema service client.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.exit

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.create_schema

create_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.CreateSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    schema: typing.Optional[google.cloud.discoveryengine_v1.types.schema.Schema] = None,
    schema_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a xref_Schema.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.create_schema

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.delete_schema

delete_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.DeleteSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a xref_Schema.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.delete_schema

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.get_operation

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.get_schema

get_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.GetSchemaRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.schema.Schema

Gets a xref_Schema.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.get_schema

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.list_operations

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.list_schemas

list_schemas(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.ListSchemasRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.services.schema_service.pagers.ListSchemasPager

Gets a list of xref_Schemas.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.list_schemas

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_schema_path

parse_schema_path(path: str) -> typing.Dict[str, str]

Parses a schema path into its component segments.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.parse_schema_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.schema_path

schema_path(project: str, location: str, data_store: str, schema: str) -> str

Returns a fully-qualified schema string.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.schema_path

google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.update_schema

update_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.schema_service.UpdateSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates a xref_Schema.

See more: google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceClient.update_schema

google.cloud.discoveryengine_v1.services.schema_service.pagers.ListSchemasAsyncPager

ListSchemasAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.schema_service.ListSchemasResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.schema_service.ListSchemasRequest,
    response: google.cloud.discoveryengine_v1.types.schema_service.ListSchemasResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.schema_service.pagers.ListSchemasAsyncPager

google.cloud.discoveryengine_v1.services.schema_service.pagers.ListSchemasPager

ListSchemasPager(
    method: typing.Callable[
        [...], google.cloud.discoveryengine_v1.types.schema_service.ListSchemasResponse
    ],
    request: google.cloud.discoveryengine_v1.types.schema_service.ListSchemasRequest,
    response: google.cloud.discoveryengine_v1.types.schema_service.ListSchemasResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.schema_service.pagers.ListSchemasPager

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient

SearchServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.search_service.transports.base.SearchServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.search_service.transports.base.SearchServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the search service async client.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.branch_path

branch_path(project: str, location: str, data_store: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.branch_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.chunk_path

chunk_path(
    project: str, location: str, data_store: str, branch: str, document: str, chunk: str
) -> str

Returns a fully-qualified chunk string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.chunk_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.document_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.search_service.transports.base.SearchServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_branch_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_chunk_path

parse_chunk_path(path: str) -> typing.Dict[str, str]

Parses a chunk path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_chunk_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_document_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.parse_session_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.search

search(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.search_service.SearchRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.services.search_service.pagers.SearchAsyncPager

Performs a search.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.search

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.search_lite

search_lite(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.search_service.SearchRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.search_service.pagers.SearchLiteAsyncPager
)

Performs a search.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.search_lite

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.serving_config_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.session_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient

SearchServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.search_service.transports.base.SearchServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.search_service.transports.base.SearchServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the search service client.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.exit

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.branch_path

branch_path(project: str, location: str, data_store: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.branch_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.chunk_path

chunk_path(
    project: str, location: str, data_store: str, branch: str, document: str, chunk: str
) -> str

Returns a fully-qualified chunk string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.chunk_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.document_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.get_operation

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.list_operations

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_branch_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_chunk_path

parse_chunk_path(path: str) -> typing.Dict[str, str]

Parses a chunk path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_chunk_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_document_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.parse_session_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.search

search(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.search_service.SearchRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.services.search_service.pagers.SearchPager

Performs a search.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.search

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.search_lite

search_lite(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.search_service.SearchRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.services.search_service.pagers.SearchLitePager

Performs a search.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.search_lite

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.serving_config_path

google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.discoveryengine_v1.services.search_service.SearchServiceClient.session_path

google.cloud.discoveryengine_v1.services.search_service.pagers.SearchAsyncPager

SearchAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.search_service.SearchResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.search_service.SearchRequest,
    response: google.cloud.discoveryengine_v1.types.search_service.SearchResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.search_service.pagers.SearchAsyncPager

google.cloud.discoveryengine_v1.services.search_service.pagers.SearchLiteAsyncPager

SearchLiteAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.search_service.SearchResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.search_service.SearchRequest,
    response: google.cloud.discoveryengine_v1.types.search_service.SearchResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.search_service.pagers.SearchLiteAsyncPager

google.cloud.discoveryengine_v1.services.search_service.pagers.SearchLitePager

SearchLitePager(
    method: typing.Callable[
        [...], google.cloud.discoveryengine_v1.types.search_service.SearchResponse
    ],
    request: google.cloud.discoveryengine_v1.types.search_service.SearchRequest,
    response: google.cloud.discoveryengine_v1.types.search_service.SearchResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.search_service.pagers.SearchLitePager

google.cloud.discoveryengine_v1.services.search_service.pagers.SearchPager

SearchPager(
    method: typing.Callable[
        [...], google.cloud.discoveryengine_v1.types.search_service.SearchResponse
    ],
    request: google.cloud.discoveryengine_v1.types.search_service.SearchRequest,
    response: google.cloud.discoveryengine_v1.types.search_service.SearchResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.search_service.pagers.SearchPager

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient

SearchTuningServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.search_tuning_service.transports.base.SearchTuningServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.search_tuning_service.transports.base.SearchTuningServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the search tuning service async client.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.custom_tuning_model_path

custom_tuning_model_path(
    project: str, location: str, data_store: str, custom_tuning_model: str
) -> str

Returns a fully-qualified custom_tuning_model string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.custom_tuning_model_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.search_tuning_service.transports.base.SearchTuningServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.list_custom_models

list_custom_models(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.search_tuning_service.ListCustomModelsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.search_tuning_service.ListCustomModelsResponse
)

Gets a list of all the custom models.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.list_custom_models

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_custom_tuning_model_path

parse_custom_tuning_model_path(path: str) -> typing.Dict[str, str]

Parses a custom_tuning_model path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_custom_tuning_model_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.train_custom_model

train_custom_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.search_tuning_service.TrainCustomModelRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Trains a custom model.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.train_custom_model

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient

SearchTuningServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.search_tuning_service.transports.base.SearchTuningServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.search_tuning_service.transports.base.SearchTuningServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the search tuning service client.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.exit

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.custom_tuning_model_path

custom_tuning_model_path(
    project: str, location: str, data_store: str, custom_tuning_model: str
) -> str

Returns a fully-qualified custom_tuning_model string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.custom_tuning_model_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.get_operation

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.list_custom_models

list_custom_models(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.search_tuning_service.ListCustomModelsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.types.search_tuning_service.ListCustomModelsResponse
)

Gets a list of all the custom models.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.list_custom_models

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.list_operations

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_custom_tuning_model_path

parse_custom_tuning_model_path(path: str) -> typing.Dict[str, str]

Parses a custom_tuning_model path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_custom_tuning_model_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.train_custom_model

train_custom_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.search_tuning_service.TrainCustomModelRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Trains a custom model.

See more: google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.train_custom_model

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient

ServingConfigServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.serving_config_service.transports.base.ServingConfigServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.serving_config_service.transports.base.ServingConfigServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the serving config service async client.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.serving_config_service.transports.base.ServingConfigServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.serving_config_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config

update_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.serving_config_service.UpdateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[
        google.cloud.discoveryengine_v1.types.serving_config.ServingConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.serving_config.ServingConfig

Updates a ServingConfig.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient

ServingConfigServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.serving_config_service.transports.base.ServingConfigServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.serving_config_service.transports.base.ServingConfigServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the serving config service client.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.exit

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.get_operation

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.list_operations

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.parse_serving_config_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.serving_config_path

google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.update_serving_config

update_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.serving_config_service.UpdateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[
        google.cloud.discoveryengine_v1.types.serving_config.ServingConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.serving_config.ServingConfig

Updates a ServingConfig.

See more: google.cloud.discoveryengine_v1.services.serving_config_service.ServingConfigServiceClient.update_serving_config

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient

SessionServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.session_service.transports.base.SessionServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.session_service.transports.base.SessionServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the session service async client.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.answer_path

answer_path(
    project: str, location: str, data_store: str, session: str, answer: str
) -> str

Returns a fully-qualified answer string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.answer_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.assist_answer_path

assist_answer_path(
    project: str,
    location: str,
    collection: str,
    engine: str,
    session: str,
    assist_answer: str,
) -> str

Returns a fully-qualified assist_answer string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.assist_answer_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.chunk_path

chunk_path(
    project: str, location: str, data_store: str, branch: str, document: str, chunk: str
) -> str

Returns a fully-qualified chunk string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.chunk_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.create_session

create_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.CreateSessionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    session: typing.Optional[
        google.cloud.discoveryengine_v1.types.session.Session
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Creates a Session.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.create_session

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.data_store_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.delete_session

delete_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.DeleteSessionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Session.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.delete_session

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.document_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.from_service_account_file

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.from_service_account_info

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.from_service_account_json

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.get_operation

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.get_session

get_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.GetSessionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Gets a Session.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.get_session

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.discoveryengine_v1.services.session_service.transports.base.SessionServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.get_transport_class

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.list_operations

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.list_sessions

list_sessions(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1.services.session_service.pagers.ListSessionsAsyncPager
)

Lists all Sessions by their parent xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.list_sessions

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_answer_path

parse_answer_path(path: str) -> typing.Dict[str, str]

Parses a answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_answer_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_assist_answer_path

parse_assist_answer_path(path: str) -> typing.Dict[str, str]

Parses a assist_answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_assist_answer_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_chunk_path

parse_chunk_path(path: str) -> typing.Dict[str, str]

Parses a chunk path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_chunk_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_document_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.parse_session_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.session_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.update_session

update_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.UpdateSessionRequest,
            dict,
        ]
    ] = None,
    *,
    session: typing.Optional[
        google.cloud.discoveryengine_v1.types.session.Session
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Updates a Session.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceAsyncClient.update_session

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient

SessionServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.session_service.transports.base.SessionServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.session_service.transports.base.SessionServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the session service client.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.exit

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.answer_path

answer_path(
    project: str, location: str, data_store: str, session: str, answer: str
) -> str

Returns a fully-qualified answer string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.answer_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.assist_answer_path

assist_answer_path(
    project: str,
    location: str,
    collection: str,
    engine: str,
    session: str,
    assist_answer: str,
) -> str

Returns a fully-qualified assist_answer string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.assist_answer_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.cancel_operation

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.chunk_path

chunk_path(
    project: str, location: str, data_store: str, branch: str, document: str, chunk: str
) -> str

Returns a fully-qualified chunk string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.chunk_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_folder_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_location_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_organization_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.common_project_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.create_session

create_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.CreateSessionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    session: typing.Optional[
        google.cloud.discoveryengine_v1.types.session.Session
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Creates a Session.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.create_session

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.data_store_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.delete_session

delete_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.DeleteSessionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Session.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.delete_session

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.document_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.from_service_account_file

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

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

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.from_service_account_file

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.from_service_account_info

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

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

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.from_service_account_info

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.from_service_account_json

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

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

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.from_service_account_json

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.get_operation

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.get_session

get_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.GetSessionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Gets a Session.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.get_session

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.list_operations

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.list_sessions

list_sessions(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.services.session_service.pagers.ListSessionsPager

Lists all Sessions by their parent xref_DataStore.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.list_sessions

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_answer_path

parse_answer_path(path: str) -> typing.Dict[str, str]

Parses a answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_answer_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_assist_answer_path

parse_assist_answer_path(path: str) -> typing.Dict[str, str]

Parses a assist_answer path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_assist_answer_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_chunk_path

parse_chunk_path(path: str) -> typing.Dict[str, str]

Parses a chunk path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_chunk_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_billing_account_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_folder_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_location_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_organization_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_common_project_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_data_store_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_document_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.parse_session_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.session_path

google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.update_session

update_session(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.conversational_search_service.UpdateSessionRequest,
            dict,
        ]
    ] = None,
    *,
    session: typing.Optional[
        google.cloud.discoveryengine_v1.types.session.Session
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session

Updates a Session.

See more: google.cloud.discoveryengine_v1.services.session_service.SessionServiceClient.update_session

google.cloud.discoveryengine_v1.services.session_service.pagers.ListSessionsAsyncPager

ListSessionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsRequest,
    response: google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.cloud.discoveryengine_v1.services.session_service.pagers.ListSessionsAsyncPager

google.cloud.discoveryengine_v1.services.session_service.pagers.ListSessionsPager

ListSessionsPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsRequest,
    response: google.cloud.discoveryengine_v1.types.conversational_search_service.ListSessionsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.cloud.discoveryengine_v1.services.session_service.pagers.ListSessionsPager

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient

SiteSearchEngineServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.discoveryengine_v1.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport,
            typing.Callable[
                [...],
                google.cloud.discoveryengine_v1.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.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
)

Instantiates the site search engine service async client.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.batch_create_target_sites

batch_create_target_sites(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.site_search_engine_service.BatchCreateTargetSitesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates xref_TargetSite in a batch.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.batch_create_target_sites

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.batch_verify_target_sites

batch_verify_target_sites(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.site_search_engine_service.BatchVerifyTargetSitesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Verify target sites' ownership and validity.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.batch_verify_target_sites

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.cancel_operation

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_billing_account_path

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_folder_path

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_location_path

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_organization_path

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_project_path

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.create_sitemap

create_sitemap(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.site_search_engine_service.CreateSitemapRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    sitemap: typing.Optional[
        google.cloud.discoveryengine_v1.types.site_search_engine.Sitemap
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a xref_Sitemap.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.create_sitemap

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.create_target_site

create_target_site(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.site_search_engine_service.CreateTargetSiteRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    target_site: typing.Optional[
        google.cloud.discoveryengine_v1.types.site_search_engine.TargetSite
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a xref_TargetSite.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.create_target_site

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.delete_sitemap

delete_sitemap(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1.types.site_search_engine_service.DeleteSitemapRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a xref_Sitemap.

See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.delete_sitemap

google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.delete_target_site

delete_target_site(
    request: typing.Optional[
        typing.Union[<