Summary of entries of Methods for discoveryengine.
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 =
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.completion_service.CompleteQueryResponse
Completes the specified user input with keyword suggestions.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports xref_CompletionSuggestions for a DataStore.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports all xref_SuggestionDenyListEntry for a DataStore.
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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Permanently deletes all xref_CompletionSuggestions for a DataStore.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Permanently deletes all xref_SuggestionDenyListEntry for a DataStore.
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 =
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, str]] = ()
) -> 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.
google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.completion_service.CompletionServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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, str]] = ()
) -> 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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> google.api_core.operation.Operation
Imports xref_CompletionSuggestions for a DataStore.
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, str]] = ()
) -> google.api_core.operation.Operation
Imports all xref_SuggestionDenyListEntry for a DataStore.
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.api_core.operation.Operation
Permanently deletes all xref_CompletionSuggestions for a DataStore.
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, str]] = ()
) -> google.api_core.operation.Operation
Permanently deletes all xref_SuggestionDenyListEntry for a DataStore.
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 =
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, str]] = ()
) -> 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.
google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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, str]] = ()
) -> 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, str]] = ()
) -> None
Deletes a Control.
See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceAsyncClient.delete_control
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.
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.
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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> (
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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 =
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, str]] = ()
) -> 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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> None
Deletes a Control.
See more: google.cloud.discoveryengine_v1.services.control_service.ControlServiceClient.delete_control
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.
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.
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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.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, str]] = ()
) -> 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, str]] = ()
)
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, str]] = ()
)
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 =
Instantiates the conversational search service async client.
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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryResponse
)
Answer query method.
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
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.
google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.conversational_search_service.ConverseConversationResponse
)
Converses a 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation
Creates a 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session
Creates a 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.
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, str]] = ()
) -> None
Deletes a 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, str]] = ()
) -> None
Deletes a 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.
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.
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.
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.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.answer.Answer
Gets a 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation
Gets a 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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session
Gets a 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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListConversationsAsyncPager
)
Lists all Conversations by their parent xref_DataStore.
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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListSessionsAsyncPager
)
Lists all Sessions by their parent xref_DataStore.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation
Updates a 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session
Updates a 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 =
Instantiates the conversational search service client.
google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.conversational_search_service.AnswerQueryResponse
)
Answer query method.
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
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.
google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.conversational_search_service.ConversationalSearchServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.conversational_search_service.ConverseConversationResponse
)
Converses a 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation
Creates a 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session
Creates a 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.
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, str]] = ()
) -> None
Deletes a 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, str]] = ()
) -> None
Deletes a 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.
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.
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.
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.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.answer.Answer
Gets a 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation
Gets a 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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session
Gets a 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListConversationsPager
)
Lists all Conversations by their parent xref_DataStore.
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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.conversational_search_service.pagers.ListSessionsPager
)
Lists all Sessions by their parent xref_DataStore.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.conversation.Conversation
Updates a 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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.session.Session
Updates a 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, str]] = ()
)
Instantiates the pager.
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, str]] = ()
)
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, str]] = ()
)
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, str]] = ()
)
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 =
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
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.
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.
google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_DataStore.
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.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_DataStore.
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.
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.
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.
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.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.data_store.DataStore
Gets a xref_DataStore.
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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresAsyncPager
)
Lists all the xref_DataStores associated with the project.
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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.data_store.DataStore
Updates a xref_DataStore.
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 =
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, str]] = ()
) -> 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.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.
google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.data_store_service.DataStoreServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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, str]] = ()
) -> 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.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, str]] = ()
) -> 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.
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.
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.
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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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.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, str]] = ()
) -> (
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, str]] = ()
) -> 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_collection_path
parse_collection_path(path: str) -> typing.Dict[str, str]
Parses a collection path into its component segments.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
)
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, str]] = ()
)
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 =
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.document_service.BatchGetDocumentsMetadataResponse
)
Gets index freshness metadata for xref_Documents.
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.document_service.DocumentServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Bulk import of multiple xref_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, str]] = ()
) -> (
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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 =
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.document_service.BatchGetDocumentsMetadataResponse
)
Gets index freshness metadata for xref_Documents.
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, str]] = ()
) -> 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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
) -> (
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
)
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, str]] = ()
)
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 =
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, str]] = ()
) -> 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.
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.
google.cloud.discoveryengine_v1.services.engine_service.EngineServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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, str]] = ()
) -> (
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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 =
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
)
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, str]] = ()
)
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 =
Instantiates the grounded generation service async client.
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.grounded_generation_service.CheckGroundingResponse
)
Performs a grounding check.
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.
google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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.
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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentResponse
)
Generates 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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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.
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.
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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> typing.Awaitable[
typing.AsyncIterable[
google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentResponse
]
]
Generates grounded content in a streaming fashion.
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 =
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.
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.grounded_generation_service.CheckGroundingResponse
)
Performs a grounding check.
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.
google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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.
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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentResponse
)
Generates 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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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.
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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1.services.grounded_generation_service.GroundedGenerationServiceClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> typing.Iterable[
google.cloud.discoveryengine_v1.types.grounded_generation_service.GenerateGroundedContentResponse
]
Generates grounded content in a streaming fashion.
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 =
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, str]] = ()
) -> 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.
google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.project_service.ProjectServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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.
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.
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.
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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 =
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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.
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, str]] = ()
) -> 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 =
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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 =
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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, str]] = ()
) -> 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 =
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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.
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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.recommendation_service.RecommendResponse
Makes a recommendation, which requires a contextual user event.
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.
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 =
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.recommendation_service.RecommendationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.recommendation_service.RecommendResponse
Makes a recommendation, which requires a contextual user event.
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.
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 =
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, str]] = ()
) -> 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.
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.
google.cloud.discoveryengine_v1.services.schema_service.SchemaServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
) -> (
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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 =
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, str]] = ()
) -> 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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
)
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, str]] = ()
)
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 =
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, str]] = ()
) -> 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.
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.
google.cloud.discoveryengine_v1.services.search_service.SearchServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> (
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 =
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, str]] = ()
) -> 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.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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.
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.
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.
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.
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.
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, str]] = ()
) -> 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, str]] = ()
) -> 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, str]] = ()
)
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, str]] = ()
)
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, str]] = ()
)
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, str]] = ()
)
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 =
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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.
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.search_tuning_service.ListCustomModelsResponse
)
Gets a list of all the 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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Trains a 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 =
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
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.
google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.search_tuning_service.SearchTuningServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.types.search_tuning_service.ListCustomModelsResponse
)
Gets a list of all the 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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
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.
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.
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.
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.
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.
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.
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.
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, str]] = ()
) -> google.api_core.operation.Operation
Trains a custom model.
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 =
Instantiates the site search engine service async client.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates xref_TargetSite in a batch.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Verify target sites' ownership and validity.
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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running 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.
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.
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.
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.
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.
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_TargetSite.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.delete_target_site
delete_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.DeleteTargetSiteRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_TargetSite.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.disable_advanced_site_search
disable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.DisableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Downgrade from advanced site search to basic site search.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.enable_advanced_site_search
enable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.EnableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Upgrade from basic site search to advanced site search.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.fetch_domain_verification_status
fetch_domain_verification_status(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager
)
Returns list of target sites with its domain verification status.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_site_search_engine
get_site_search_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.GetSiteSearchEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.site_search_engine.SiteSearchEngine
Gets the xref_SiteSearchEngine.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_target_site
get_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.GetTargetSiteRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.site_search_engine.TargetSite
Gets a xref_TargetSite.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.list_target_sites
list_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.ListTargetSitesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager
)
Gets a list of xref_TargetSites.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_site_search_engine_path
parse_site_search_engine_path(path: str) -> typing.Dict[str, str]
Parses a site_search_engine path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_target_site_path
parse_target_site_path(path: str) -> typing.Dict[str, str]
Parses a target_site path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.recrawl_uris
recrawl_uris(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.RecrawlUrisRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Request on-demand recrawl for a list of URIs.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.site_search_engine_path
site_search_engine_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified site_search_engine string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.target_site_path
target_site_path(
project: str, location: str, data_store: str, target_site: str
) -> str
Returns a fully-qualified target_site string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.update_target_site
update_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.UpdateTargetSiteRequest,
dict,
]
] = 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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a xref_TargetSite.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient
SiteSearchEngineServiceClient(*, 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]]] = 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 =
Instantiates the site search engine service client.
See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.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.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, str]] = ()
) -> google.api_core.operation.Operation
Creates xref_TargetSite in a batch.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.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.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, str]] = ()
) -> google.api_core.operation.Operation
Verify target sites' ownership and validity.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.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.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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_TargetSite.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.delete_target_site
delete_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.DeleteTargetSiteRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_TargetSite.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.disable_advanced_site_search
disable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.DisableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Downgrade from advanced site search to basic site search.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.enable_advanced_site_search
enable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.EnableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Upgrade from basic site search to advanced site search.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.fetch_domain_verification_status
fetch_domain_verification_status(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager
)
Returns list of target sites with its domain verification status.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.get_site_search_engine
get_site_search_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.GetSiteSearchEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.site_search_engine.SiteSearchEngine
Gets the xref_SiteSearchEngine.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.get_target_site
get_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.GetTargetSiteRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.site_search_engine.TargetSite
Gets a xref_TargetSite.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.list_target_sites
list_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.ListTargetSitesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.ListTargetSitesPager
)
Gets a list of xref_TargetSites.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.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.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_site_search_engine_path
parse_site_search_engine_path(path: str) -> typing.Dict[str, str]
Parses a site_search_engine path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_target_site_path
parse_target_site_path(path: str) -> typing.Dict[str, str]
Parses a target_site path into its component segments.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.recrawl_uris
recrawl_uris(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.RecrawlUrisRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Request on-demand recrawl for a list of URIs.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.site_search_engine_path
site_search_engine_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified site_search_engine string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.target_site_path
target_site_path(
project: str, location: str, data_store: str, target_site: str
) -> str
Returns a fully-qualified target_site string.
google.cloud.discoveryengine_v1.services.site_search_engine_service.SiteSearchEngineServiceClient.update_target_site
update_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.site_search_engine_service.UpdateTargetSiteRequest,
dict,
]
] = 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.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, str]] = ()
) -> google.api_core.operation.Operation
Updates a xref_TargetSite.
google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager
FetchDomainVerificationStatusAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1.types.site_search_engine_service.FetchDomainVerificationStatusResponse
],
],
request: google.cloud.discoveryengine_v1.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
response: google.cloud.discoveryengine_v1.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager
FetchDomainVerificationStatusPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
],
request: google.cloud.discoveryengine_v1.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
response: google.cloud.discoveryengine_v1.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
*,
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, str]] = ()
)
Instantiate the pager.
google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager
ListTargetSitesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1.types.site_search_engine_service.ListTargetSitesResponse
],
],
request: google.cloud.discoveryengine_v1.types.site_search_engine_service.ListTargetSitesRequest,
response: google.cloud.discoveryengine_v1.types.site_search_engine_service.ListTargetSitesResponse,
*,
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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager
google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.ListTargetSitesPager
ListTargetSitesPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1.types.site_search_engine_service.ListTargetSitesResponse,
],
request: google.cloud.discoveryengine_v1.types.site_search_engine_service.ListTargetSitesRequest,
response: google.cloud.discoveryengine_v1.types.site_search_engine_service.ListTargetSitesResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.ListTargetSitesPager
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient
UserEventServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1.services.user_event_service.transports.base.UserEventServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the user event service async client.
See more: google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.collect_user_event
collect_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.user_event_service.CollectUserEventRequest,
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, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Writes a single user event from the browser.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.document_path
document_path(
project: str, location: str, data_store: str, branch: str, document: str
) -> str
Returns a fully-qualified document string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.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.user_event_service.UserEventServiceAsyncClient.engine_path
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.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.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1.services.user_event_service.transports.base.UserEventServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.import_user_events
import_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.import_config.ImportUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Bulk import of user events.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.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.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.purge_user_events
purge_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.purge_config.PurgeUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes permanently all user events specified by the filter provided.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceAsyncClient.write_user_event
write_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.user_event_service.WriteUserEventRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.user_event.UserEvent
Writes a single user event.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient
UserEventServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1.services.user_event_service.transports.base.UserEventServiceTransport]]] = 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 =
Instantiates the user event service client.
See more: google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.exit
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.cancel_operation
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.collect_user_event
collect_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.user_event_service.CollectUserEventRequest,
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, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Writes a single user event from the browser.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.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.user_event_service.UserEventServiceClient.data_store_path
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.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.user_event_service.UserEventServiceClient.document_path
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.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.user_event_service.UserEventServiceClient.engine_path
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.get_operation
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.import_user_events
import_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.import_config.ImportUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Bulk import of user events.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.list_operations
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.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.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.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.user_event_service.UserEventServiceClient.parse_engine_path
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.purge_user_events
purge_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.purge_config.PurgeUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Deletes permanently all user events specified by the filter provided.
See more: google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.purge_user_events
google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.write_user_event
write_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1.types.user_event_service.WriteUserEventRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1.types.user_event.UserEvent
Writes a single user event.
See more: google.cloud.discoveryengine_v1.services.user_event_service.UserEventServiceClient.write_user_event
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient
AclConfigServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.acl_config_service.transports.base.AclConfigServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.acl_config_service.transports.base.AclConfigServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the acl config service async client.
See more: google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.acl_config_path
acl_config_path(project: str, location: str) -> str
Returns a fully-qualified acl_config string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.get_acl_config
get_acl_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.acl_config_service.GetAclConfigRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.acl_config.AclConfig
Gets the xref_AclConfig.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.acl_config_service.transports.base.AclConfigServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.parse_acl_config_path
parse_acl_config_path(path: str) -> typing.Dict[str, str]
Parses a acl_config path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceAsyncClient.update_acl_config
update_acl_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.acl_config_service.UpdateAclConfigRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.acl_config.AclConfig
Default ACL configuration for use in a location of a customer's project.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient
AclConfigServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.acl_config_service.transports.base.AclConfigServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.acl_config_service.transports.base.AclConfigServiceTransport]]] = 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 =
Instantiates the acl config service client.
See more: google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.exit
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.acl_config_path
acl_config_path(project: str, location: str) -> str
Returns a fully-qualified acl_config string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.get_acl_config
get_acl_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.acl_config_service.GetAclConfigRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.acl_config.AclConfig
Gets the xref_AclConfig.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.parse_acl_config_path
parse_acl_config_path(path: str) -> typing.Dict[str, str]
Parses a acl_config path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.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.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.acl_config_service.AclConfigServiceClient.update_acl_config
update_acl_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.acl_config_service.UpdateAclConfigRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.acl_config.AclConfig
Default ACL configuration for use in a location of a customer's project.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient
ChunkServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.chunk_service.transports.base.ChunkServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.chunk_service.transports.base.ChunkServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the chunk service async client.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.cancel_operation
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.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_v1alpha.services.chunk_service.ChunkServiceAsyncClient.chunk_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.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_v1alpha.services.chunk_service.ChunkServiceAsyncClient.document_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.get_chunk
get_chunk(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.chunk_service.GetChunkRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.chunk.Chunk
Gets a xref_Document.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.get_chunk
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.chunk_service.transports.base.ChunkServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.list_chunks
list_chunks(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.chunk_service.ListChunksRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.chunk_service.pagers.ListChunksAsyncPager
)
Gets a list of xref_Chunks.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.list_chunks
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.list_operations
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.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_v1alpha.services.chunk_service.ChunkServiceAsyncClient.parse_chunk_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient
ChunkServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.chunk_service.transports.base.ChunkServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.chunk_service.transports.base.ChunkServiceTransport]]] = 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 =
Instantiates the chunk service client.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.exit
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.cancel_operation
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.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_v1alpha.services.chunk_service.ChunkServiceClient.chunk_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.common_folder_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.common_location_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.common_project_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.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_v1alpha.services.chunk_service.ChunkServiceClient.document_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.get_chunk
get_chunk(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.chunk_service.GetChunkRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.chunk.Chunk
Gets a xref_Document.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.get_chunk
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.get_operation
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.list_chunks
list_chunks(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.chunk_service.ListChunksRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.services.chunk_service.pagers.ListChunksPager
Gets a list of xref_Chunks.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.list_chunks
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.list_operations
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.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_v1alpha.services.chunk_service.ChunkServiceClient.parse_chunk_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.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.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.chunk_service.ChunkServiceClient.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_v1alpha.services.chunk_service.ChunkServiceClient.parse_document_path
google.cloud.discoveryengine_v1alpha.services.chunk_service.pagers.ListChunksAsyncPager
ListChunksAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.chunk_service.ListChunksResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.chunk_service.ListChunksRequest,
response: google.cloud.discoveryengine_v1alpha.types.chunk_service.ListChunksResponse,
*,
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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.pagers.ListChunksAsyncPager
google.cloud.discoveryengine_v1alpha.services.chunk_service.pagers.ListChunksPager
ListChunksPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.chunk_service.ListChunksResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.chunk_service.ListChunksRequest,
response: google.cloud.discoveryengine_v1alpha.types.chunk_service.ListChunksResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.chunk_service.pagers.ListChunksPager
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient
CompletionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.completion_service.transports.base.CompletionServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the completion service async client.
See more: google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.complete_query
complete_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.completion_service.CompleteQueryResponse
)
Completes the specified user input with keyword suggestions.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.completion_service.transports.base.CompletionServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.import_completion_suggestions
import_completion_suggestions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports xref_CompletionSuggestions for a DataStore.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.import_suggestion_deny_list_entries
import_suggestion_deny_list_entries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports all xref_SuggestionDenyListEntry for a DataStore.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.purge_completion_suggestions
purge_completion_suggestions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Permanently deletes all xref_CompletionSuggestions for a DataStore.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceAsyncClient.purge_suggestion_deny_list_entries
purge_suggestion_deny_list_entries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Permanently deletes all xref_SuggestionDenyListEntry for a DataStore.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient
CompletionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.completion_service.transports.base.CompletionServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the completion service client.
See more: google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.complete_query
complete_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.completion_service.CompleteQueryResponse
)
Completes the specified user input with keyword suggestions.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.import_completion_suggestions
import_completion_suggestions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Imports xref_CompletionSuggestions for a DataStore.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.import_suggestion_deny_list_entries
import_suggestion_deny_list_entries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Imports all xref_SuggestionDenyListEntry for a DataStore.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.purge_completion_suggestions
purge_completion_suggestions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Permanently deletes all xref_CompletionSuggestions for a DataStore.
google.cloud.discoveryengine_v1alpha.services.completion_service.CompletionServiceClient.purge_suggestion_deny_list_entries
purge_suggestion_deny_list_entries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Permanently deletes all xref_SuggestionDenyListEntry for a DataStore.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient
ControlServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the control service async client.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.control_service.ControlServiceAsyncClient.control_path
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.create_control
create_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.control_service.CreateControlRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
control: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.control.Control
Creates a Control.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.delete_control
delete_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Deletes a Control.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.get_control
get_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.control.Control
Gets a Control.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.get_control
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.control_service.transports.base.ControlServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.list_controls
list_controls(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.control_service.pagers.ListControlsAsyncPager
)
Lists all Controls by their parent xref_DataStore.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.parse_control_path
parse_control_path(path: str) -> typing.Dict[str, str]
Parses a control path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceAsyncClient.update_control
update_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.control_service.UpdateControlRequest,
dict,
]
] = None,
*,
control: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.control.Control
Updates a Control.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient
ControlServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the control service client.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.cancel_operation
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.control_service.ControlServiceClient.control_path
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.create_control
create_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.control_service.CreateControlRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
control: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.control.Control
Creates a Control.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.create_control
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.control_service.ControlServiceClient.data_store_path
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.delete_control
delete_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Deletes a Control.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.delete_control
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.get_control
get_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.control.Control
Gets a Control.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.get_control
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.get_operation
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.list_controls
list_controls(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.control_service.pagers.ListControlsPager
)
Lists all Controls by their parent xref_DataStore.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.list_controls
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.list_operations
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.parse_control_path
parse_control_path(path: str) -> typing.Dict[str, str]
Parses a control path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.update_control
update_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.control_service.UpdateControlRequest,
dict,
]
] = None,
*,
control: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.control.Control
Updates a Control.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.ControlServiceClient.update_control
google.cloud.discoveryengine_v1alpha.services.control_service.pagers.ListControlsAsyncPager
ListControlsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.control_service.ListControlsResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.control_service.ListControlsRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.pagers.ListControlsAsyncPager
google.cloud.discoveryengine_v1alpha.services.control_service.pagers.ListControlsPager
ListControlsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.control_service.ListControlsResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.control_service.ListControlsRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.control_service.pagers.ListControlsPager
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient
ConversationalSearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the conversational search service async client.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.answer_query
answer_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.AnswerQueryResponse
)
Answer query method.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.converse_conversation
converse_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ConverseConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
query: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ConverseConversationResponse
)
Converses a conversation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.create_conversation
create_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.CreateConversationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
conversation: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.conversation.Conversation
Creates a Conversation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.create_session
create_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.CreateSessionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
session: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.session.Session
Creates a Session.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.delete_conversation
delete_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Deletes a Conversation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.delete_session
delete_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Deletes a Session.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_answer
get_answer(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.answer.Answer
Gets a Answer.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_conversation
get_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.conversation.Conversation
Gets a Conversation.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_session
get_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.session.Session
Gets a Session.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_conversations
list_conversations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListConversationsAsyncPager
)
Lists all Conversations by their parent xref_DataStore.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_sessions
list_sessions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListSessionsAsyncPager
)
Lists all Sessions by their parent xref_DataStore.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.update_conversation
update_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.UpdateConversationRequest,
dict,
]
] = None,
*,
conversation: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.conversation.Conversation
Updates a Conversation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceAsyncClient.update_session
update_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.UpdateSessionRequest,
dict,
]
] = None,
*,
session: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.session.Session
Updates a Session.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient
ConversationalSearchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the conversational search service client.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.answer_query
answer_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.AnswerQueryResponse
)
Answer query method.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.converse_conversation
converse_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ConverseConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
query: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ConverseConversationResponse
)
Converses a conversation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.create_conversation
create_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.CreateConversationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
conversation: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.conversation.Conversation
Creates a Conversation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.create_session
create_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.CreateSessionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
session: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.session.Session
Creates a Session.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.delete_conversation
delete_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Deletes a Conversation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.delete_session
delete_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Deletes a Session.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.get_answer
get_answer(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.answer.Answer
Gets a Answer.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.get_conversation
get_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.conversation.Conversation
Gets a Conversation.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.get_session
get_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.session.Session
Gets a Session.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.list_conversations
list_conversations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListConversationsPager
)
Lists all Conversations by their parent xref_DataStore.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.list_sessions
list_sessions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListSessionsPager
)
Lists all Sessions by their parent xref_DataStore.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.update_conversation
update_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.UpdateConversationRequest,
dict,
]
] = None,
*,
conversation: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.conversation.Conversation
Updates a Conversation.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.ConversationalSearchServiceClient.update_session
update_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.UpdateSessionRequest,
dict,
]
] = None,
*,
session: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.session.Session
Updates a Session.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListConversationsAsyncPager
ListConversationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListConversationsResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListConversationsRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListConversationsPager
ListConversationsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListConversationsResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListConversationsRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiate the pager.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListSessionsAsyncPager
ListSessionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListSessionsPager
ListSessionsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.conversational_search_service.pagers.ListSessionsPager
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient
DataStoreServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.data_store_service.transports.base.DataStoreServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the data store service async client.
See more: google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.collection_path
collection_path(project: str, location: str, collection: str) -> str
Returns a fully-qualified collection string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.create_data_store
create_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.data_store_service.CreateDataStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
data_store: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_DataStore.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.delete_data_store
delete_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_DataStore.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.get_data_store
get_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.data_store.DataStore
Gets a xref_DataStore.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.get_document_processing_config
get_document_processing_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.data_store_service.GetDocumentProcessingConfigRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.document_processing_config.DocumentProcessingConfig
)
Gets a xref_DocumentProcessingConfig.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.data_store_service.transports.base.DataStoreServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.list_data_stores
list_data_stores(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.data_store_service.pagers.ListDataStoresAsyncPager
)
Lists all the xref_DataStores associated with the project.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.update_data_store
update_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.data_store_service.UpdateDataStoreRequest,
dict,
]
] = None,
*,
data_store: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.data_store.DataStore
Updates a xref_DataStore.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceAsyncClient.update_document_processing_config
update_document_processing_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.data_store_service.UpdateDocumentProcessingConfigRequest,
dict,
]
] = None,
*,
document_processing_config: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.document_processing_config.DocumentProcessingConfig
] = 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.document_processing_config.DocumentProcessingConfig
)
Updates the xref_DocumentProcessingConfig.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient
DataStoreServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.data_store_service.transports.base.DataStoreServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the data store service client.
See more: google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.collection_path
collection_path(project: str, location: str, collection: str) -> str
Returns a fully-qualified collection string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.create_data_store
create_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.data_store_service.CreateDataStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
data_store: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_DataStore.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.delete_data_store
delete_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_DataStore.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.get_data_store
get_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.data_store.DataStore
Gets a xref_DataStore.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.get_document_processing_config
get_document_processing_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.data_store_service.GetDocumentProcessingConfigRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.document_processing_config.DocumentProcessingConfig
)
Gets a xref_DocumentProcessingConfig.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.list_data_stores
list_data_stores(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.data_store_service.pagers.ListDataStoresPager
)
Lists all the xref_DataStores associated with the project.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.data_store_service.DataStoreServiceClient.schema_path
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.update_data_store
update_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.data_store_service.UpdateDataStoreRequest,
dict,
]
] = None,
*,
data_store: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.data_store.DataStore
Updates a xref_DataStore.
google.cloud.discoveryengine_v1alpha.services.data_store_service.DataStoreServiceClient.update_document_processing_config
update_document_processing_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.data_store_service.UpdateDocumentProcessingConfigRequest,
dict,
]
] = None,
*,
document_processing_config: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.document_processing_config.DocumentProcessingConfig
] = 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.document_processing_config.DocumentProcessingConfig
)
Updates the xref_DocumentProcessingConfig.
google.cloud.discoveryengine_v1alpha.services.data_store_service.pagers.ListDataStoresAsyncPager
ListDataStoresAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.data_store_service.ListDataStoresResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.data_store_service.ListDataStoresRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1alpha.services.data_store_service.pagers.ListDataStoresAsyncPager
google.cloud.discoveryengine_v1alpha.services.data_store_service.pagers.ListDataStoresPager
ListDataStoresPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.data_store_service.ListDataStoresResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.data_store_service.ListDataStoresRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.data_store_service.pagers.ListDataStoresPager
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient
DocumentServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.document_service.transports.base.DocumentServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the document service async client.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.batch_get_documents_metadata
batch_get_documents_metadata(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.document_service.BatchGetDocumentsMetadataResponse
)
Gets index freshness metadata for xref_Documents.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.branch_path
branch_path(project: str, location: str, data_store: str, branch: str) -> str
Returns a fully-qualified branch string.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.create_document
create_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.document_service.CreateDocumentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
document: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.document.Document
Creates a xref_Document.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.delete_document
delete_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Deletes a xref_Document.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.get_document
get_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.document.Document
Gets a xref_Document.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.get_processed_document
get_processed_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.document_service.GetProcessedDocumentRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.document.ProcessedDocument
Gets the parsed layout information for a xref_Document.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.document_service.transports.base.DocumentServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.import_documents
import_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Bulk import of multiple xref_Documents.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.list_documents
list_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.document_service.pagers.ListDocumentsAsyncPager
)
Gets a list of xref_Documents.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.purge_documents
purge_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Permanently deletes all selected xref_Documents in a branch.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceAsyncClient.update_document
update_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.document_service.UpdateDocumentRequest,
dict,
]
] = None,
*,
document: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.document.Document
Updates a xref_Document.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient
DocumentServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.document_service.transports.base.DocumentServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the document service client.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.exit
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.batch_get_documents_metadata
batch_get_documents_metadata(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.document_service.BatchGetDocumentsMetadataResponse
)
Gets index freshness metadata for xref_Documents.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.document_service.DocumentServiceClient.branch_path
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.create_document
create_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.document_service.CreateDocumentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
document: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.document.Document
Creates a xref_Document.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.create_document
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.delete_document
delete_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Deletes a xref_Document.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.delete_document
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.document_service.DocumentServiceClient.document_path
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.document_service.DocumentServiceClient.fhir_store_path
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.get_document
get_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.document.Document
Gets a xref_Document.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.get_document
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.get_operation
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.get_processed_document
get_processed_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.document_service.GetProcessedDocumentRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.document.ProcessedDocument
Gets the parsed layout information for a xref_Document.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.import_documents
import_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Bulk import of multiple xref_Documents.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.list_documents
list_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.document_service.pagers.ListDocumentsPager
)
Gets a list of xref_Documents.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.list_documents
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.list_operations
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.purge_documents
purge_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Permanently deletes all selected xref_Documents in a branch.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.purge_documents
google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.update_document
update_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.document_service.UpdateDocumentRequest,
dict,
]
] = None,
*,
document: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.document.Document
Updates a xref_Document.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.DocumentServiceClient.update_document
google.cloud.discoveryengine_v1alpha.services.document_service.pagers.ListDocumentsAsyncPager
ListDocumentsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.document_service.ListDocumentsResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.document_service.ListDocumentsRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.pagers.ListDocumentsAsyncPager
google.cloud.discoveryengine_v1alpha.services.document_service.pagers.ListDocumentsPager
ListDocumentsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.document_service.ListDocumentsResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.document_service.ListDocumentsRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.document_service.pagers.ListDocumentsPager
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient
EngineServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.engine_service.transports.base.EngineServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the engine service async client.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.collection_path
collection_path(project: str, location: str, collection: str) -> str
Returns a fully-qualified collection string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.create_engine
create_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.CreateEngineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
engine: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_Engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.create_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.delete_engine
delete_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_Engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.delete_engine
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.engine_service.EngineServiceAsyncClient.engine_path
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.get_engine
get_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.engine.Engine
Gets a xref_Engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.get_engine
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.engine_service.transports.base.EngineServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.list_engines
list_engines(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.engine_service.pagers.ListEnginesAsyncPager
)
Lists all the xref_Engines associated with the project.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.list_engines
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.parse_collection_path
parse_collection_path(path: str) -> typing.Dict[str, str]
Parses a collection path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.pause_engine
pause_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.PauseEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.engine.Engine
Pauses the training of an existing engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.pause_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.resume_engine
resume_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.ResumeEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.engine.Engine
Resumes the training of an existing engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.resume_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.tune_engine
tune_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.TuneEngineRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Tunes an existing engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.tune_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.update_engine
update_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.UpdateEngineRequest,
dict,
]
] = None,
*,
engine: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.engine.Engine
Updates an xref_Engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceAsyncClient.update_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient
EngineServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.engine_service.transports.base.EngineServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the engine service client.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.cancel_operation
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.engine_service.EngineServiceClient.collection_path
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.common_folder_path
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.common_project_path
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.create_engine
create_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.CreateEngineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
engine: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_Engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.create_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.delete_engine
delete_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_Engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.delete_engine
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.engine_service.EngineServiceClient.engine_path
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.get_engine
get_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.engine.Engine
Gets a xref_Engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.get_engine
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.get_operation
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.list_engines
list_engines(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.engine_service.pagers.ListEnginesPager
)
Lists all the xref_Engines associated with the project.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.list_engines
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.list_operations
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.parse_collection_path
parse_collection_path(path: str) -> typing.Dict[str, str]
Parses a collection path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.engine_service.EngineServiceClient.parse_engine_path
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.pause_engine
pause_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.PauseEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.engine.Engine
Pauses the training of an existing engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.pause_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.resume_engine
resume_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.ResumeEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.engine.Engine
Resumes the training of an existing engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.resume_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.tune_engine
tune_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.TuneEngineRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Tunes an existing engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.tune_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.update_engine
update_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.engine_service.UpdateEngineRequest,
dict,
]
] = None,
*,
engine: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.engine.Engine
Updates an xref_Engine.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.EngineServiceClient.update_engine
google.cloud.discoveryengine_v1alpha.services.engine_service.pagers.ListEnginesAsyncPager
ListEnginesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.pagers.ListEnginesAsyncPager
google.cloud.discoveryengine_v1alpha.services.engine_service.pagers.ListEnginesPager
ListEnginesPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.engine_service.pagers.ListEnginesPager
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient
EstimateBillingServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.transports.base.EstimateBillingServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.transports.base.EstimateBillingServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the estimate billing service async client.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.estimate_data_size
estimate_data_size(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.estimate_billing_service.EstimateDataSizeRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Estimates the data size to be used by a customer.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.transports.base.EstimateBillingServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceAsyncClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient
EstimateBillingServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.transports.base.EstimateBillingServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.transports.base.EstimateBillingServiceTransport]]] = 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 =
Instantiates the estimate billing service client.
See more: google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.estimate_data_size
estimate_data_size(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.estimate_billing_service.EstimateDataSizeRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Estimates the data size to be used by a customer.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.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.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.estimate_billing_service.EstimateBillingServiceClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient
EvaluationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the evaluation service async client.
See more: google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.branch_path
branch_path(project: str, location: str, data_store: str, branch: str) -> str
Returns a fully-qualified branch string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.create_evaluation
create_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.CreateEvaluationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
evaluation: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.evaluation.Evaluation
] = 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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_Evaluation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.evaluation_path
evaluation_path(project: str, location: str, evaluation: str) -> str
Returns a fully-qualified evaluation string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.get_evaluation
get_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.GetEvaluationRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.evaluation.Evaluation
Gets a xref_Evaluation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.list_evaluation_results
list_evaluation_results(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsRequest,
dict,
]
] = None,
*,
evaluation: 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsAsyncPager
)
Gets a list of results for a given a xref_Evaluation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.list_evaluations
list_evaluations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsAsyncPager
)
Gets a list of xref_Evaluations.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_evaluation_path
parse_evaluation_path(path: str) -> typing.Dict[str, str]
Parses a evaluation path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_sample_query_path
parse_sample_query_path(path: str) -> typing.Dict[str, str]
Parses a sample_query path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_serving_config_path
parse_serving_config_path(path: str) -> typing.Dict[str, str]
Parses a serving_config path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.parse_session_path
parse_session_path(path: str) -> typing.Dict[str, str]
Parses a session path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.sample_query_path
sample_query_path(
project: str, location: str, sample_query_set: str, sample_query: str
) -> str
Returns a fully-qualified sample_query string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.serving_config_path
serving_config_path(
project: str, location: str, data_store: str, serving_config: str
) -> str
Returns a fully-qualified serving_config string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceAsyncClient.session_path
session_path(project: str, location: str, data_store: str, session: str) -> str
Returns a fully-qualified session string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient
EvaluationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport]]] = 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 =
Instantiates the evaluation service client.
See more: google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.exit
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.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_v1alpha.services.evaluation_service.EvaluationServiceClient.branch_path
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.create_evaluation
create_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.CreateEvaluationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
evaluation: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.evaluation.Evaluation
] = 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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_Evaluation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.evaluation_path
evaluation_path(project: str, location: str, evaluation: str) -> str
Returns a fully-qualified evaluation string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.get_evaluation
get_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.GetEvaluationRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.evaluation.Evaluation
Gets a xref_Evaluation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.list_evaluation_results
list_evaluation_results(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsRequest,
dict,
]
] = None,
*,
evaluation: 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsPager
)
Gets a list of results for a given a xref_Evaluation.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.list_evaluations
list_evaluations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsPager
)
Gets a list of xref_Evaluations.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.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.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_evaluation_path
parse_evaluation_path(path: str) -> typing.Dict[str, str]
Parses a evaluation path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_sample_query_path
parse_sample_query_path(path: str) -> typing.Dict[str, str]
Parses a sample_query path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_serving_config_path
parse_serving_config_path(path: str) -> typing.Dict[str, str]
Parses a serving_config path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.parse_session_path
parse_session_path(path: str) -> typing.Dict[str, str]
Parses a session path into its component segments.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.sample_query_path
sample_query_path(
project: str, location: str, sample_query_set: str, sample_query: str
) -> str
Returns a fully-qualified sample_query string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.serving_config_path
serving_config_path(
project: str, location: str, data_store: str, serving_config: str
) -> str
Returns a fully-qualified serving_config string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.EvaluationServiceClient.session_path
session_path(project: str, location: str, data_store: str, session: str) -> str
Returns a fully-qualified session string.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsAsyncPager
ListEvaluationResultsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsRequest,
response: google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsPager
ListEvaluationResultsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsRequest,
response: google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsPager
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsAsyncPager
ListEvaluationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsRequest,
response: google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsResponse,
*,
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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsAsyncPager
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsPager
ListEvaluationsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsRequest,
response: google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsPager
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceAsyncClient
GroundedGenerationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the grounded generation service async client.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.check_grounding
check_grounding(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.grounded_generation_service.CheckGroundingResponse
)
Performs a grounding check.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceClient
GroundedGenerationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the grounded generation service client.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceClient.check_grounding
check_grounding(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.grounded_generation_service.CheckGroundingResponse
)
Performs a grounding check.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.grounded_generation_service.GroundedGenerationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient
ProjectServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.project_service.transports.base.ProjectServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the project service async client.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.get_project
get_project(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.project_service.GetProjectRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.project.Project
Gets a xref_Project.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.get_project
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.project_service.transports.base.ProjectServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.parse_project_path
parse_project_path(path: str) -> typing.Dict[str, str]
Parses a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.project_path
project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.project_path
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.provision_project
provision_project(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Provisions the project resource.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceAsyncClient.report_consent_change
report_consent_change(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.project_service.ReportConsentChangeRequest,
dict,
]
] = None,
*,
consent_change_action: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.project_service.ReportConsentChangeRequest.ConsentChangeAction
] = None,
project: typing.Optional[str] = None,
service_term_id: typing.Optional[str] = None,
service_term_version: 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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.project.Project
Updates service terms for this project.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient
ProjectServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.project_service.transports.base.ProjectServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the project service client.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.cancel_operation
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.get_operation
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.get_project
get_project(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.project_service.GetProjectRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.project.Project
Gets a xref_Project.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.get_project
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.list_operations
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.parse_project_path
parse_project_path(path: str) -> typing.Dict[str, str]
Parses a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.project_path
project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.project_path
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.provision_project
provision_project(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Provisions the project resource.
See more: google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.provision_project
google.cloud.discoveryengine_v1alpha.services.project_service.ProjectServiceClient.report_consent_change
report_consent_change(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.project_service.ReportConsentChangeRequest,
dict,
]
] = None,
*,
consent_change_action: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.project_service.ReportConsentChangeRequest.ConsentChangeAction
] = None,
project: typing.Optional[str] = None,
service_term_id: typing.Optional[str] = None,
service_term_version: 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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.project.Project
Updates service terms for this project.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient
RankServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.rank_service.transports.base.RankServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the rank service async client.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.cancel_operation
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.common_folder_path
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.rank_service.transports.base.RankServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.list_operations
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.rank
rank(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.rank_service.RankResponse
Ranks a list of text records based on the given input query.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceAsyncClient.rank
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient
RankServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.rank_service.transports.base.RankServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the rank service client.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.cancel_operation
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.common_folder_path
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.rank_service.RankServiceClient.common_location_path
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.common_project_path
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.get_operation
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.list_operations
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.rank
rank(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.rank_service.RankResponse
Ranks a list of text records based on the given input query.
See more: google.cloud.discoveryengine_v1alpha.services.rank_service.RankServiceClient.rank
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.rank_service.RankServiceClient.ranking_config_path
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient
RecommendationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.recommendation_service.transports.base.RecommendationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the recommendation service async client.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.engine_path
engine_path(project: str, location: str, collection: str, engine: str) -> str
Returns a fully-qualified engine string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.recommendation_service.transports.base.RecommendationServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceAsyncClient.recommend
recommend(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.recommendation_service.RecommendResponse
)
Makes a recommendation, which requires a contextual user event.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient
RecommendationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.recommendation_service.transports.base.RecommendationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the recommendation service client.
See more: google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.engine_path
engine_path(project: str, location: str, collection: str, engine: str) -> str
Returns a fully-qualified engine string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.recommendation_service.RecommendationServiceClient.recommend
recommend(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.recommendation_service.RecommendResponse
)
Makes a recommendation, which requires a contextual user event.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient
SampleQueryServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.sample_query_service.transports.base.SampleQueryServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.sample_query_service.transports.base.SampleQueryServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the sample query service async client.
See more: google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.create_sample_query
create_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.CreateSampleQueryRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
sample_query: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
] = None,
sample_query_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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
Creates a xref_SampleQuery.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.delete_sample_query
delete_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.DeleteSampleQueryRequest,
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, str]] = ()
) -> None
Deletes a xref_SampleQuery.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.get_sample_query
get_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.GetSampleQueryRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
Gets a xref_SampleQuery.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.sample_query_service.transports.base.SampleQueryServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.import_sample_queries
import_sample_queries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.import_config.ImportSampleQueriesRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Bulk import of multiple xref_SampleQuerys.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.list_sample_queries
list_sample_queries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.ListSampleQueriesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.sample_query_service.pagers.ListSampleQueriesAsyncPager
)
Gets a list of xref_SampleQuerys.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.parse_sample_query_path
parse_sample_query_path(path: str) -> typing.Dict[str, str]
Parses a sample_query path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.sample_query_path
sample_query_path(
project: str, location: str, sample_query_set: str, sample_query: str
) -> str
Returns a fully-qualified sample_query string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceAsyncClient.update_sample_query
update_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.UpdateSampleQueryRequest,
dict,
]
] = None,
*,
sample_query: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
] = 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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
Updates a xref_SampleQuery.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient
SampleQueryServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.sample_query_service.transports.base.SampleQueryServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.sample_query_service.transports.base.SampleQueryServiceTransport]]] = 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 =
Instantiates the sample query service client.
See more: google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.exit
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.create_sample_query
create_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.CreateSampleQueryRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
sample_query: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
] = None,
sample_query_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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
Creates a xref_SampleQuery.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.delete_sample_query
delete_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.DeleteSampleQueryRequest,
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, str]] = ()
) -> None
Deletes a xref_SampleQuery.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.get_sample_query
get_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.GetSampleQueryRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
Gets a xref_SampleQuery.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.import_sample_queries
import_sample_queries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.import_config.ImportSampleQueriesRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Bulk import of multiple xref_SampleQuerys.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.list_sample_queries
list_sample_queries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.ListSampleQueriesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.sample_query_service.pagers.ListSampleQueriesPager
)
Gets a list of xref_SampleQuerys.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.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.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.parse_sample_query_path
parse_sample_query_path(path: str) -> typing.Dict[str, str]
Parses a sample_query path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.sample_query_path
sample_query_path(
project: str, location: str, sample_query_set: str, sample_query: str
) -> str
Returns a fully-qualified sample_query string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.SampleQueryServiceClient.update_sample_query
update_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.UpdateSampleQueryRequest,
dict,
]
] = None,
*,
sample_query: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
] = 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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query.SampleQuery
Updates a xref_SampleQuery.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.pagers.ListSampleQueriesAsyncPager
ListSampleQueriesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.sample_query_service.ListSampleQueriesResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.sample_query_service.ListSampleQueriesRequest,
response: google.cloud.discoveryengine_v1alpha.types.sample_query_service.ListSampleQueriesResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1alpha.services.sample_query_service.pagers.ListSampleQueriesPager
ListSampleQueriesPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.sample_query_service.ListSampleQueriesResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.sample_query_service.ListSampleQueriesRequest,
response: google.cloud.discoveryengine_v1alpha.types.sample_query_service.ListSampleQueriesResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.sample_query_service.pagers.ListSampleQueriesPager
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient
SampleQuerySetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the sample query set service async client.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.create_sample_query_set
create_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.CreateSampleQuerySetRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
sample_query_set: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
] = None,
sample_query_set_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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
Creates a xref_SampleQuerySet.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.delete_sample_query_set
delete_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.DeleteSampleQuerySetRequest,
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, str]] = ()
) -> None
Deletes a xref_SampleQuerySet.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.get_sample_query_set
get_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.GetSampleQuerySetRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
Gets a xref_SampleQuerySet.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.list_sample_query_sets
list_sample_query_sets(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.ListSampleQuerySetsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.pagers.ListSampleQuerySetsAsyncPager
)
Gets a list of xref_SampleQuerySets.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.update_sample_query_set
update_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.UpdateSampleQuerySetRequest,
dict,
]
] = None,
*,
sample_query_set: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
] = 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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
Updates a xref_SampleQuerySet.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient
SampleQuerySetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport]]] = 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 =
Instantiates the sample query set service client.
See more: google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.create_sample_query_set
create_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.CreateSampleQuerySetRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
sample_query_set: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
] = None,
sample_query_set_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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
Creates a xref_SampleQuerySet.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.delete_sample_query_set
delete_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.DeleteSampleQuerySetRequest,
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, str]] = ()
) -> None
Deletes a xref_SampleQuerySet.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.get_sample_query_set
get_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.GetSampleQuerySetRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
Gets a xref_SampleQuerySet.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.list_sample_query_sets
list_sample_query_sets(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.ListSampleQuerySetsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.pagers.ListSampleQuerySetsPager
)
Gets a list of xref_SampleQuerySets.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.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.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.SampleQuerySetServiceClient.update_sample_query_set
update_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.UpdateSampleQuerySetRequest,
dict,
]
] = None,
*,
sample_query_set: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
] = 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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.sample_query_set.SampleQuerySet
Updates a xref_SampleQuerySet.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.pagers.ListSampleQuerySetsAsyncPager
ListSampleQuerySetsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.ListSampleQuerySetsResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.ListSampleQuerySetsRequest,
response: google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.ListSampleQuerySetsResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.pagers.ListSampleQuerySetsPager
ListSampleQuerySetsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.ListSampleQuerySetsResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.ListSampleQuerySetsRequest,
response: google.cloud.discoveryengine_v1alpha.types.sample_query_set_service.ListSampleQuerySetsResponse,
*,
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, str]] = ()
)
Instantiate the pager.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient
SchemaServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.schema_service.transports.base.SchemaServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the schema service async client.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.create_schema
create_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.schema_service.CreateSchemaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schema: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_Schema.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.create_schema
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.delete_schema
delete_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_Schema.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.delete_schema
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.get_schema
get_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.schema.Schema
Gets a xref_Schema.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.get_schema
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.schema_service.transports.base.SchemaServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.list_schemas
list_schemas(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.schema_service.pagers.ListSchemasAsyncPager
)
Gets a list of xref_Schemas.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.list_schemas
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.parse_schema_path
parse_schema_path(path: str) -> typing.Dict[str, str]
Parses a schema path into its component segments.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.schema_service.SchemaServiceAsyncClient.schema_path
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.update_schema
update_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a xref_Schema.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceAsyncClient.update_schema
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient
SchemaServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.schema_service.transports.base.SchemaServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the schema service client.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.cancel_operation
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.common_folder_path
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.common_project_path
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.create_schema
create_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.schema_service.CreateSchemaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schema: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_Schema.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.create_schema
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.schema_service.SchemaServiceClient.data_store_path
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.delete_schema
delete_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_Schema.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.delete_schema
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.get_operation
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.get_schema
get_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.schema.Schema
Gets a xref_Schema.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.get_schema
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.list_operations
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.list_schemas
list_schemas(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.schema_service.pagers.ListSchemasPager
)
Gets a list of xref_Schemas.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.list_schemas
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.schema_service.SchemaServiceClient.parse_schema_path
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.schema_service.SchemaServiceClient.schema_path
google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.update_schema
update_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Updates a xref_Schema.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.SchemaServiceClient.update_schema
google.cloud.discoveryengine_v1alpha.services.schema_service.pagers.ListSchemasAsyncPager
ListSchemasAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.schema_service.ListSchemasResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.schema_service.ListSchemasRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.pagers.ListSchemasAsyncPager
google.cloud.discoveryengine_v1alpha.services.schema_service.pagers.ListSchemasPager
ListSchemasPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.schema_service.ListSchemasResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.schema_service.ListSchemasRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.schema_service.pagers.ListSchemasPager
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient
SearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the search service async client.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceAsyncClient.branch_path
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceAsyncClient.chunk_path
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceAsyncClient.document_path
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.search_service.transports.base.SearchServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.parse_chunk_path
parse_chunk_path(path: str) -> typing.Dict[str, str]
Parses a chunk path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.parse_session_path
parse_session_path(path: str) -> typing.Dict[str, str]
Parses a session path into its component segments.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.search
search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.search_service.pagers.SearchAsyncPager
)
Performs a search.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceAsyncClient.search
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceAsyncClient.session_path
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient
SearchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the search service client.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.exit
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.branch_path
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.cancel_operation
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.chunk_path
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.common_folder_path
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.common_project_path
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.data_store_path
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.document_path
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.get_operation
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.list_operations
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.parse_branch_path
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.parse_chunk_path
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.parse_document_path
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.parse_session_path
google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.search
search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.services.search_service.pagers.SearchPager
Performs a search.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.SearchServiceClient.search
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.serving_config_path
google.cloud.discoveryengine_v1alpha.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_v1alpha.services.search_service.SearchServiceClient.session_path
google.cloud.discoveryengine_v1alpha.services.search_service.pagers.SearchAsyncPager
SearchAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.search_service.SearchResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.search_service.SearchRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.pagers.SearchAsyncPager
google.cloud.discoveryengine_v1alpha.services.search_service.pagers.SearchPager
SearchPager(
method: typing.Callable[
[...], google.cloud.discoveryengine_v1alpha.types.search_service.SearchResponse
],
request: google.cloud.discoveryengine_v1alpha.types.search_service.SearchRequest,
response: google.cloud.discoveryengine_v1alpha.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.search_service.pagers.SearchPager
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient
SearchTuningServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.search_tuning_service.transports.base.SearchTuningServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the search tuning service async client.
See more: google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.transports.base.SearchTuningServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient.list_custom_models
list_custom_models(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.search_tuning_service.ListCustomModelsResponse
)
Gets a list of all the custom models.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceAsyncClient.train_custom_model
train_custom_model(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Trains a custom model.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient
SearchTuningServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.search_tuning_service.transports.base.SearchTuningServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the search tuning service client.
See more: google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.list_custom_models
list_custom_models(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.search_tuning_service.ListCustomModelsResponse
)
Gets a list of all the custom models.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.search_tuning_service.SearchTuningServiceClient.train_custom_model
train_custom_model(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation.Operation
Trains a custom model.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient
ServingConfigServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the serving config service async client.
See more: google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_serving_config
get_serving_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.serving_config_service.GetServingConfigRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.serving_config.ServingConfig
Gets a ServingConfig.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.serving_config_service.transports.base.ServingConfigServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.list_serving_configs
list_serving_configs(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.serving_config_service.ListServingConfigsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.serving_config_service.pagers.ListServingConfigsAsyncPager
)
Lists all ServingConfigs linked to this dataStore.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config
update_serving_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.serving_config_service.UpdateServingConfigRequest,
dict,
]
] = None,
*,
serving_config: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.serving_config.ServingConfig
Updates a ServingConfig.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient
ServingConfigServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the serving config service client.
See more: google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.exit
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.get_serving_config
get_serving_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.serving_config_service.GetServingConfigRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.serving_config.ServingConfig
Gets a ServingConfig.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.list_serving_configs
list_serving_configs(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.serving_config_service.ListServingConfigsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.serving_config_service.pagers.ListServingConfigsPager
)
Lists all ServingConfigs linked to this dataStore.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.ServingConfigServiceClient.update_serving_config
update_serving_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.serving_config_service.UpdateServingConfigRequest,
dict,
]
] = None,
*,
serving_config: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.serving_config.ServingConfig
Updates a ServingConfig.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.pagers.ListServingConfigsAsyncPager
ListServingConfigsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.serving_config_service.ListServingConfigsResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.serving_config_service.ListServingConfigsRequest,
response: google.cloud.discoveryengine_v1alpha.types.serving_config_service.ListServingConfigsResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1alpha.services.serving_config_service.pagers.ListServingConfigsPager
ListServingConfigsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.serving_config_service.ListServingConfigsResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.serving_config_service.ListServingConfigsRequest,
response: google.cloud.discoveryengine_v1alpha.types.serving_config_service.ListServingConfigsResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.serving_config_service.pagers.ListServingConfigsPager
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient
SiteSearchEngineServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.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 =
Instantiates the site search engine service async client.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.batch_create_target_sites
batch_create_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates xref_TargetSite in a batch.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.batch_verify_target_sites
batch_verify_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Verify target sites' ownership and validity.
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.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.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.create_target_site
create_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.CreateTargetSiteRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
target_site: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_TargetSite.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.delete_target_site
delete_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.DeleteTargetSiteRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_TargetSite.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.disable_advanced_site_search
disable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.DisableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Downgrade from advanced site search to basic site search.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.enable_advanced_site_search
enable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.EnableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Upgrade from basic site search to advanced site search.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.fetch_domain_verification_status
fetch_domain_verification_status(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager
)
Returns list of target sites with its domain verification status.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_site_search_engine
get_site_search_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.GetSiteSearchEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.site_search_engine.SiteSearchEngine
Gets the xref_SiteSearchEngine.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_target_site
get_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.GetTargetSiteRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.site_search_engine.TargetSite
Gets a xref_TargetSite.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_uri_pattern_document_data
get_uri_pattern_document_data(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.GetUriPatternDocumentDataRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.GetUriPatternDocumentDataResponse
)
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.list_target_sites
list_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager
)
Gets a list of xref_TargetSites.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_site_search_engine_path
parse_site_search_engine_path(path: str) -> typing.Dict[str, str]
Parses a site_search_engine path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_target_site_path
parse_target_site_path(path: str) -> typing.Dict[str, str]
Parses a target_site path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.recrawl_uris
recrawl_uris(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.RecrawlUrisRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Request on-demand recrawl for a list of URIs.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.set_uri_pattern_document_data
set_uri_pattern_document_data(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.SetUriPatternDocumentDataRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.site_search_engine_path
site_search_engine_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified site_search_engine string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.target_site_path
target_site_path(
project: str, location: str, data_store: str, target_site: str
) -> str
Returns a fully-qualified target_site string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.update_target_site
update_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.UpdateTargetSiteRequest,
dict,
]
] = None,
*,
target_site: typing.Optional[
google.cloud.discoveryengine_v1alpha.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a xref_TargetSite.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient
SiteSearchEngineServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport]]] = 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 =
Instantiates the site search engine service client.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.batch_create_target_sites
batch_create_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.BatchCreateTargetSitesRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Creates xref_TargetSite in a batch.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.batch_verify_target_sites
batch_verify_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.BatchVerifyTargetSitesRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Verify target sites' ownership and validity.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.create_target_site
create_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.CreateTargetSiteRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
target_site: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.site_search_engine.TargetSite
] = 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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_TargetSite.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.delete_target_site
delete_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.DeleteTargetSiteRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_TargetSite.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.disable_advanced_site_search
disable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.DisableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Downgrade from advanced site search to basic site search.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.enable_advanced_site_search
enable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.EnableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Upgrade from basic site search to advanced site search.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.fetch_domain_verification_status
fetch_domain_verification_status(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager
)
Returns list of target sites with its domain verification status.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.get_site_search_engine
get_site_search_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.GetSiteSearchEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.site_search_engine.SiteSearchEngine
Gets the xref_SiteSearchEngine.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.get_target_site
get_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.GetTargetSiteRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.site_search_engine.TargetSite
Gets a xref_TargetSite.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.get_uri_pattern_document_data
get_uri_pattern_document_data(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.GetUriPatternDocumentDataRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.GetUriPatternDocumentDataResponse
)
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.list_target_sites
list_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.ListTargetSitesPager
)
Gets a list of xref_TargetSites.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.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.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_site_search_engine_path
parse_site_search_engine_path(path: str) -> typing.Dict[str, str]
Parses a site_search_engine path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_target_site_path
parse_target_site_path(path: str) -> typing.Dict[str, str]
Parses a target_site path into its component segments.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.recrawl_uris
recrawl_uris(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.RecrawlUrisRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Request on-demand recrawl for a list of URIs.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.set_uri_pattern_document_data
set_uri_pattern_document_data(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.SetUriPatternDocumentDataRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.site_search_engine_path
site_search_engine_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified site_search_engine string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.target_site_path
target_site_path(
project: str, location: str, data_store: str, target_site: str
) -> str
Returns a fully-qualified target_site string.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.SiteSearchEngineServiceClient.update_target_site
update_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.UpdateTargetSiteRequest,
dict,
]
] = None,
*,
target_site: typing.Optional[
google.cloud.discoveryengine_v1alpha.types.site_search_engine.TargetSite
] = 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, str]] = ()
) -> google.api_core.operation.Operation
Updates a xref_TargetSite.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager
FetchDomainVerificationStatusAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.FetchDomainVerificationStatusResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
response: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager
FetchDomainVerificationStatusPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
response: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
*,
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, str]] = ()
)
Instantiate the pager.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager
ListTargetSitesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesResponse
],
],
request: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesRequest,
response: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.ListTargetSitesPager
ListTargetSitesPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesResponse,
],
request: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesRequest,
response: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.ListTargetSitesPager
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient
UserEventServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.user_event_service.transports.base.UserEventServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the user event service async client.
See more: google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.collect_user_event
collect_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.user_event_service.CollectUserEventRequest,
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, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Writes a single user event from the browser.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.document_path
document_path(
project: str, location: str, data_store: str, branch: str, document: str
) -> str
Returns a fully-qualified document string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.engine_path
engine_path(project: str, location: str, collection: str, engine: str) -> str
Returns a fully-qualified engine string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1alpha.services.user_event_service.transports.base.UserEventServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.import_user_events
import_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.import_config.ImportUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Bulk import of user events.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.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.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.purge_user_events
purge_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.purge_config.PurgeUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes permanently all user events specified by the filter provided.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceAsyncClient.write_user_event
write_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.user_event_service.WriteUserEventRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.user_event.UserEvent
Writes a single user event.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient
UserEventServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.user_event_service.transports.base.UserEventServiceTransport]]] = 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 =
Instantiates the user event service client.
See more: google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.exit
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.collect_user_event
collect_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.user_event_service.CollectUserEventRequest,
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, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Writes a single user event from the browser.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.document_path
document_path(
project: str, location: str, data_store: str, branch: str, document: str
) -> str
Returns a fully-qualified document string.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.engine_path
engine_path(project: str, location: str, collection: str, engine: str) -> str
Returns a fully-qualified engine string.
See more: google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.engine_path
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.import_user_events
import_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.import_config.ImportUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Bulk import of user events.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.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.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.purge_user_events
purge_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.purge_config.PurgeUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Deletes permanently all user events specified by the filter provided.
google.cloud.discoveryengine_v1alpha.services.user_event_service.UserEventServiceClient.write_user_event
write_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1alpha.types.user_event_service.WriteUserEventRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.user_event.UserEvent
Writes a single user event.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient
CompletionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.completion_service.transports.base.CompletionServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the completion service async client.
See more: google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.complete_query
complete_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.completion_service.CompleteQueryResponse
Completes the specified user input with keyword suggestions.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.completion_service.transports.base.CompletionServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.import_completion_suggestions
import_completion_suggestions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports xref_CompletionSuggestions for a DataStore.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.import_suggestion_deny_list_entries
import_suggestion_deny_list_entries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports all xref_SuggestionDenyListEntry for a DataStore.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.purge_completion_suggestions
purge_completion_suggestions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Permanently deletes all xref_CompletionSuggestions for a DataStore.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceAsyncClient.purge_suggestion_deny_list_entries
purge_suggestion_deny_list_entries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Permanently deletes all xref_SuggestionDenyListEntry for a DataStore.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient
CompletionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.completion_service.transports.base.CompletionServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the completion service client.
See more: google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.complete_query
complete_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.completion_service.CompleteQueryResponse
Completes the specified user input with keyword suggestions.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.import_completion_suggestions
import_completion_suggestions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Imports xref_CompletionSuggestions for a DataStore.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.import_suggestion_deny_list_entries
import_suggestion_deny_list_entries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Imports all xref_SuggestionDenyListEntry for a DataStore.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.purge_completion_suggestions
purge_completion_suggestions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Permanently deletes all xref_CompletionSuggestions for a DataStore.
google.cloud.discoveryengine_v1beta.services.completion_service.CompletionServiceClient.purge_suggestion_deny_list_entries
purge_suggestion_deny_list_entries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Permanently deletes all xref_SuggestionDenyListEntry for a DataStore.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient
ControlServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the control service async client.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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_v1beta.services.control_service.ControlServiceAsyncClient.control_path
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.create_control
create_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.control_service.CreateControlRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
control: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.control.Control
Creates a Control.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.delete_control
delete_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Deletes a Control.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.get_control
get_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.control.Control
Gets a Control.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.get_control
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.control_service.transports.base.ControlServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.list_controls
list_controls(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.control_service.pagers.ListControlsAsyncPager
)
Lists all Controls by their parent xref_DataStore.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.list_controls
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.parse_control_path
parse_control_path(path: str) -> typing.Dict[str, str]
Parses a control path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceAsyncClient.update_control
update_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.control_service.UpdateControlRequest,
dict,
]
] = None,
*,
control: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.control.Control
Updates a Control.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient
ControlServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the control service client.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.cancel_operation
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.common_folder_path
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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_v1beta.services.control_service.ControlServiceClient.control_path
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.create_control
create_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.control_service.CreateControlRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
control: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.control.Control
Creates a Control.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.create_control
google.cloud.discoveryengine_v1beta.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_v1beta.services.control_service.ControlServiceClient.data_store_path
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.delete_control
delete_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Deletes a Control.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.delete_control
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.get_control
get_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.control.Control
Gets a Control.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.get_control
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.get_operation
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.list_controls
list_controls(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.control_service.pagers.ListControlsPager
)
Lists all Controls by their parent xref_DataStore.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.list_controls
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.list_operations
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.control_service.ControlServiceClient.parse_control_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.update_control
update_control(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.control_service.UpdateControlRequest,
dict,
]
] = None,
*,
control: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.control.Control
Updates a Control.
See more: google.cloud.discoveryengine_v1beta.services.control_service.ControlServiceClient.update_control
google.cloud.discoveryengine_v1beta.services.control_service.pagers.ListControlsAsyncPager
ListControlsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.control_service.ListControlsResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.control_service.ListControlsRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1beta.services.control_service.pagers.ListControlsAsyncPager
google.cloud.discoveryengine_v1beta.services.control_service.pagers.ListControlsPager
ListControlsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.control_service.ListControlsResponse,
],
request: google.cloud.discoveryengine_v1beta.types.control_service.ListControlsRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.control_service.pagers.ListControlsPager
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient
ConversationalSearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the conversational search service async client.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.answer_query
answer_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.conversational_search_service.AnswerQueryResponse
)
Answer query method.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.converse_conversation
converse_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ConverseConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
query: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ConverseConversationResponse
)
Converses a conversation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.create_conversation
create_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.CreateConversationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
conversation: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.conversation.Conversation
Creates a Conversation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.create_session
create_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.CreateSessionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
session: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.session.Session
Creates a Session.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.delete_conversation
delete_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Deletes a Conversation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.delete_session
delete_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Deletes a Session.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_answer
get_answer(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.answer.Answer
Gets a Answer.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_conversation
get_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.conversation.Conversation
Gets a Conversation.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_session
get_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.session.Session
Gets a Session.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_conversations
list_conversations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListConversationsAsyncPager
)
Lists all Conversations by their parent xref_DataStore.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.list_sessions
list_sessions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListSessionsAsyncPager
)
Lists all Sessions by their parent xref_DataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.update_conversation
update_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.UpdateConversationRequest,
dict,
]
] = None,
*,
conversation: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.conversation.Conversation
Updates a Conversation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceAsyncClient.update_session
update_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.UpdateSessionRequest,
dict,
]
] = None,
*,
session: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.session.Session
Updates a Session.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient
ConversationalSearchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the conversational search service client.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.answer_query
answer_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.conversational_search_service.AnswerQueryResponse
)
Answer query method.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.converse_conversation
converse_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ConverseConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
query: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ConverseConversationResponse
)
Converses a conversation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.create_conversation
create_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.CreateConversationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
conversation: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.conversation.Conversation
Creates a Conversation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.create_session
create_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.CreateSessionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
session: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.session.Session
Creates a Session.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.delete_conversation
delete_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Deletes a Conversation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.delete_session
delete_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Deletes a Session.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.get_answer
get_answer(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.answer.Answer
Gets a Answer.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.get_conversation
get_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.conversation.Conversation
Gets a Conversation.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.get_session
get_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.session.Session
Gets a Session.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.list_conversations
list_conversations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListConversationsPager
)
Lists all Conversations by their parent xref_DataStore.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.list_sessions
list_sessions(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListSessionsPager
)
Lists all Sessions by their parent xref_DataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.update_conversation
update_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.UpdateConversationRequest,
dict,
]
] = None,
*,
conversation: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.conversation.Conversation
Updates a Conversation.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.ConversationalSearchServiceClient.update_session
update_session(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.UpdateSessionRequest,
dict,
]
] = None,
*,
session: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.session.Session
Updates a Session.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListConversationsAsyncPager
ListConversationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListConversationsResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListConversationsRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListConversationsPager
ListConversationsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListConversationsResponse,
],
request: google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListConversationsRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiate the pager.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListSessionsAsyncPager
ListSessionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListSessionsResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListSessionsRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListSessionsPager
ListSessionsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListSessionsResponse,
],
request: google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListSessionsRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.conversational_search_service.pagers.ListSessionsPager
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient
DataStoreServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.data_store_service.transports.base.DataStoreServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the data store service async client.
See more: google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.collection_path
collection_path(project: str, location: str, collection: str) -> str
Returns a fully-qualified collection string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.create_data_store
create_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.data_store_service.CreateDataStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
data_store: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_DataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.delete_data_store
delete_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_DataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.get_data_store
get_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.data_store.DataStore
Gets a xref_DataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.data_store_service.transports.base.DataStoreServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.list_data_stores
list_data_stores(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.data_store_service.pagers.ListDataStoresAsyncPager
)
Lists all the xref_DataStores associated with the project.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceAsyncClient.update_data_store
update_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.data_store_service.UpdateDataStoreRequest,
dict,
]
] = None,
*,
data_store: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.data_store.DataStore
Updates a xref_DataStore.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient
DataStoreServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.data_store_service.transports.base.DataStoreServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the data store service client.
See more: google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.collection_path
collection_path(project: str, location: str, collection: str) -> str
Returns a fully-qualified collection string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.create_data_store
create_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.data_store_service.CreateDataStoreRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
data_store: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_DataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.delete_data_store
delete_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_DataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.get_data_store
get_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.data_store.DataStore
Gets a xref_DataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.get_operation
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.list_data_stores
list_data_stores(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.data_store_service.pagers.ListDataStoresPager
)
Lists all the xref_DataStores associated with the project.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.data_store_service.DataStoreServiceClient.schema_path
google.cloud.discoveryengine_v1beta.services.data_store_service.DataStoreServiceClient.update_data_store
update_data_store(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.data_store_service.UpdateDataStoreRequest,
dict,
]
] = None,
*,
data_store: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.data_store.DataStore
Updates a xref_DataStore.
google.cloud.discoveryengine_v1beta.services.data_store_service.pagers.ListDataStoresAsyncPager
ListDataStoresAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.data_store_service.ListDataStoresResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.data_store_service.ListDataStoresRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1beta.services.data_store_service.pagers.ListDataStoresAsyncPager
google.cloud.discoveryengine_v1beta.services.data_store_service.pagers.ListDataStoresPager
ListDataStoresPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.data_store_service.ListDataStoresResponse,
],
request: google.cloud.discoveryengine_v1beta.types.data_store_service.ListDataStoresRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.data_store_service.pagers.ListDataStoresPager
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient
DocumentServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the document service async client.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.batch_get_documents_metadata
batch_get_documents_metadata(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.document_service.BatchGetDocumentsMetadataResponse
)
Gets index freshness metadata for xref_Documents.
google.cloud.discoveryengine_v1beta.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_v1beta.services.document_service.DocumentServiceAsyncClient.branch_path
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.create_document
create_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.document_service.CreateDocumentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
document: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document
Creates a xref_Document.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.delete_document
delete_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Deletes a xref_Document.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.get_document
get_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document
Gets a xref_Document.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.import_documents
import_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Bulk import of multiple xref_Documents.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.list_documents
list_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsAsyncPager
)
Gets a list of xref_Documents.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.purge_documents
purge_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Permanently deletes all selected xref_Documents in a branch.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceAsyncClient.update_document
update_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.document_service.UpdateDocumentRequest,
dict,
]
] = None,
*,
document: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document
Updates a xref_Document.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient
DocumentServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the document service client.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.exit
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.batch_get_documents_metadata
batch_get_documents_metadata(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.document_service.BatchGetDocumentsMetadataResponse
)
Gets index freshness metadata for xref_Documents.
google.cloud.discoveryengine_v1beta.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_v1beta.services.document_service.DocumentServiceClient.branch_path
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.cancel_operation
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.create_document
create_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.document_service.CreateDocumentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
document: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document
Creates a xref_Document.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.create_document
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.delete_document
delete_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Deletes a xref_Document.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.delete_document
google.cloud.discoveryengine_v1beta.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_v1beta.services.document_service.DocumentServiceClient.document_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.document_service.DocumentServiceClient.fhir_store_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.get_document
get_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document
Gets a xref_Document.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.get_document
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.get_operation
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.import_documents
import_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Bulk import of multiple xref_Documents.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.import_documents
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.list_documents
list_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsPager
)
Gets a list of xref_Documents.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.list_documents
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.list_operations
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.purge_documents
purge_documents(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Permanently deletes all selected xref_Documents in a branch.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.purge_documents
google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.update_document
update_document(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.document_service.UpdateDocumentRequest,
dict,
]
] = None,
*,
document: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document
Updates a xref_Document.
See more: google.cloud.discoveryengine_v1beta.services.document_service.DocumentServiceClient.update_document
google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsAsyncPager
ListDocumentsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsAsyncPager
google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsPager
ListDocumentsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsResponse,
],
request: google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsPager
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient
EngineServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.engine_service.transports.base.EngineServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the engine service async client.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.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_v1beta.services.engine_service.EngineServiceAsyncClient.collection_path
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.create_engine
create_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.CreateEngineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
engine: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_Engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.create_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.delete_engine
delete_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_Engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.delete_engine
google.cloud.discoveryengine_v1beta.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_v1beta.services.engine_service.EngineServiceAsyncClient.engine_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.get_engine
get_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.engine.Engine
Gets a xref_Engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.get_engine
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.engine_service.transports.base.EngineServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.list_engines
list_engines(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.engine_service.pagers.ListEnginesAsyncPager
)
Lists all the xref_Engines associated with the project.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.list_engines
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.list_operations
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.parse_collection_path
parse_collection_path(path: str) -> typing.Dict[str, str]
Parses a collection path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.pause_engine
pause_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.PauseEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.engine.Engine
Pauses the training of an existing engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.pause_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.resume_engine
resume_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.ResumeEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.engine.Engine
Resumes the training of an existing engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.resume_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.tune_engine
tune_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.TuneEngineRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Tunes an existing engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.tune_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.update_engine
update_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.UpdateEngineRequest,
dict,
]
] = None,
*,
engine: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.engine.Engine
Updates an xref_Engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceAsyncClient.update_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient
EngineServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.engine_service.transports.base.EngineServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the engine service client.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.cancel_operation
google.cloud.discoveryengine_v1beta.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_v1beta.services.engine_service.EngineServiceClient.collection_path
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.common_folder_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.engine_service.EngineServiceClient.common_location_path
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.common_project_path
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.create_engine
create_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.CreateEngineRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
engine: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_Engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.create_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.delete_engine
delete_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_Engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.delete_engine
google.cloud.discoveryengine_v1beta.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_v1beta.services.engine_service.EngineServiceClient.engine_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.get_engine
get_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.engine.Engine
Gets a xref_Engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.get_engine
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.get_operation
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.list_engines
list_engines(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.engine_service.pagers.ListEnginesPager
)
Lists all the xref_Engines associated with the project.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.list_engines
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.list_operations
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.parse_collection_path
parse_collection_path(path: str) -> typing.Dict[str, str]
Parses a collection path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.engine_service.EngineServiceClient.parse_engine_path
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.pause_engine
pause_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.PauseEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.engine.Engine
Pauses the training of an existing engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.pause_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.resume_engine
resume_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.ResumeEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.engine.Engine
Resumes the training of an existing engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.resume_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.tune_engine
tune_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.TuneEngineRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Tunes an existing engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.tune_engine
google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.update_engine
update_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.engine_service.UpdateEngineRequest,
dict,
]
] = None,
*,
engine: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.engine.Engine
Updates an xref_Engine.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.EngineServiceClient.update_engine
google.cloud.discoveryengine_v1beta.services.engine_service.pagers.ListEnginesAsyncPager
ListEnginesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.engine_service.ListEnginesResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.engine_service.ListEnginesRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.pagers.ListEnginesAsyncPager
google.cloud.discoveryengine_v1beta.services.engine_service.pagers.ListEnginesPager
ListEnginesPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.engine_service.ListEnginesResponse,
],
request: google.cloud.discoveryengine_v1beta.types.engine_service.ListEnginesRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.engine_service.pagers.ListEnginesPager
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient
EvaluationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.evaluation_service.transports.base.EvaluationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.evaluation_service.transports.base.EvaluationServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the evaluation service async client.
See more: google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.branch_path
branch_path(project: str, location: str, data_store: str, branch: str) -> str
Returns a fully-qualified branch string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.create_evaluation
create_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.evaluation_service.CreateEvaluationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
evaluation: typing.Optional[
google.cloud.discoveryengine_v1beta.types.evaluation.Evaluation
] = 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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_Evaluation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.evaluation_path
evaluation_path(project: str, location: str, evaluation: str) -> str
Returns a fully-qualified evaluation string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.get_evaluation
get_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.evaluation_service.GetEvaluationRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.evaluation.Evaluation
Gets a xref_Evaluation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.evaluation_service.transports.base.EvaluationServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.list_evaluation_results
list_evaluation_results(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationResultsRequest,
dict,
]
] = None,
*,
evaluation: 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationResultsAsyncPager
)
Gets a list of results for a given a xref_Evaluation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.list_evaluations
list_evaluations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationsAsyncPager
)
Gets a list of xref_Evaluations.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_evaluation_path
parse_evaluation_path(path: str) -> typing.Dict[str, str]
Parses a evaluation path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_sample_query_path
parse_sample_query_path(path: str) -> typing.Dict[str, str]
Parses a sample_query path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_serving_config_path
parse_serving_config_path(path: str) -> typing.Dict[str, str]
Parses a serving_config path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.parse_session_path
parse_session_path(path: str) -> typing.Dict[str, str]
Parses a session path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.sample_query_path
sample_query_path(
project: str, location: str, sample_query_set: str, sample_query: str
) -> str
Returns a fully-qualified sample_query string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.serving_config_path
serving_config_path(
project: str, location: str, data_store: str, serving_config: str
) -> str
Returns a fully-qualified serving_config string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceAsyncClient.session_path
session_path(project: str, location: str, data_store: str, session: str) -> str
Returns a fully-qualified session string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient
EvaluationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.evaluation_service.transports.base.EvaluationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.evaluation_service.transports.base.EvaluationServiceTransport]]] = 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 =
Instantiates the evaluation service client.
See more: google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.exit
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.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_v1beta.services.evaluation_service.EvaluationServiceClient.branch_path
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.create_evaluation
create_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.evaluation_service.CreateEvaluationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
evaluation: typing.Optional[
google.cloud.discoveryengine_v1beta.types.evaluation.Evaluation
] = 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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_Evaluation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.evaluation_path
evaluation_path(project: str, location: str, evaluation: str) -> str
Returns a fully-qualified evaluation string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.get_evaluation
get_evaluation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.evaluation_service.GetEvaluationRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.evaluation.Evaluation
Gets a xref_Evaluation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.list_evaluation_results
list_evaluation_results(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationResultsRequest,
dict,
]
] = None,
*,
evaluation: 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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationResultsPager
)
Gets a list of results for a given a xref_Evaluation.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.list_evaluations
list_evaluations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationsPager
)
Gets a list of xref_Evaluations.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.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.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_evaluation_path
parse_evaluation_path(path: str) -> typing.Dict[str, str]
Parses a evaluation path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_sample_query_path
parse_sample_query_path(path: str) -> typing.Dict[str, str]
Parses a sample_query path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_serving_config_path
parse_serving_config_path(path: str) -> typing.Dict[str, str]
Parses a serving_config path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.parse_session_path
parse_session_path(path: str) -> typing.Dict[str, str]
Parses a session path into its component segments.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.sample_query_path
sample_query_path(
project: str, location: str, sample_query_set: str, sample_query: str
) -> str
Returns a fully-qualified sample_query string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.serving_config_path
serving_config_path(
project: str, location: str, data_store: str, serving_config: str
) -> str
Returns a fully-qualified serving_config string.
google.cloud.discoveryengine_v1beta.services.evaluation_service.EvaluationServiceClient.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_v1beta.services.evaluation_service.EvaluationServiceClient.session_path
google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationResultsAsyncPager
ListEvaluationResultsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationResultsResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationResultsRequest,
response: google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationResultsResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationResultsPager
ListEvaluationResultsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationResultsResponse,
],
request: google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationResultsRequest,
response: google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationResultsResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationResultsPager
google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationsAsyncPager
ListEvaluationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationsResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationsRequest,
response: google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationsResponse,
*,
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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationsAsyncPager
google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationsPager
ListEvaluationsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationsResponse,
],
request: google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationsRequest,
response: google.cloud.discoveryengine_v1beta.types.evaluation_service.ListEvaluationsResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationsPager
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceAsyncClient
GroundedGenerationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the grounded generation service async client.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.check_grounding
check_grounding(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.grounded_generation_service.CheckGroundingResponse
)
Performs a grounding check.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceClient
GroundedGenerationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.grounded_generation_service.transports.base.GroundedGenerationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the grounded generation service client.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceClient.check_grounding
check_grounding(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.grounded_generation_service.CheckGroundingResponse
)
Performs a grounding check.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.grounded_generation_service.GroundedGenerationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient
ProjectServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.project_service.transports.base.ProjectServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the project service async client.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.project_service.transports.base.ProjectServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.parse_project_path
parse_project_path(path: str) -> typing.Dict[str, str]
Parses a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.project_path
project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.project_path
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceAsyncClient.provision_project
provision_project(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Provisions the project resource.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient
ProjectServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.project_service.transports.base.ProjectServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the project service client.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.cancel_operation
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.common_folder_path
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.get_operation
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.list_operations
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.project_service.ProjectServiceClient.parse_project_path
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.project_path
project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.project_path
google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.provision_project
provision_project(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Provisions the project resource.
See more: google.cloud.discoveryengine_v1beta.services.project_service.ProjectServiceClient.provision_project
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient
RankServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.rank_service.transports.base.RankServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the rank service async client.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.cancel_operation
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.common_folder_path
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.common_project_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.rank_service.transports.base.RankServiceTransport
]
Returns an appropriate transport class.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.get_transport_class
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.list_operations
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.rank
rank(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.rank_service.RankResponse
Ranks a list of text records based on the given input query.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceAsyncClient.rank
google.cloud.discoveryengine_v1beta.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_v1beta.services.rank_service.RankServiceAsyncClient.ranking_config_path
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient
RankServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.rank_service.transports.base.RankServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the rank service client.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.cancel_operation
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.common_folder_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.rank_service.RankServiceClient.common_location_path
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.common_organization_path
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.common_project_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.get_operation
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.list_operations
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.rank_service.RankServiceClient.parse_common_folder_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.rank
rank(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.rank_service.RankResponse
Ranks a list of text records based on the given input query.
See more: google.cloud.discoveryengine_v1beta.services.rank_service.RankServiceClient.rank
google.cloud.discoveryengine_v1beta.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_v1beta.services.rank_service.RankServiceClient.ranking_config_path
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient
RecommendationServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.recommendation_service.transports.base.RecommendationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the recommendation service async client.
See more: google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.engine_path
engine_path(project: str, location: str, collection: str, engine: str) -> str
Returns a fully-qualified engine string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.recommendation_service.transports.base.RecommendationServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceAsyncClient.recommend
recommend(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.recommendation_service.RecommendResponse
Makes a recommendation, which requires a contextual user event.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient
RecommendationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.recommendation_service.transports.base.RecommendationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the recommendation service client.
See more: google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.engine_path
engine_path(project: str, location: str, collection: str, engine: str) -> str
Returns a fully-qualified engine string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.recommendation_service.RecommendationServiceClient.recommend
recommend(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.recommendation_service.RecommendResponse
Makes a recommendation, which requires a contextual user event.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient
SampleQueryServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the sample query service async client.
See more: google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.create_sample_query
create_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.CreateSampleQueryRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
sample_query: typing.Optional[
google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
] = None,
sample_query_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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
Creates a xref_SampleQuery.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.delete_sample_query
delete_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.DeleteSampleQueryRequest,
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, str]] = ()
) -> None
Deletes a xref_SampleQuery.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.get_sample_query
get_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.GetSampleQueryRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
Gets a xref_SampleQuery.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.import_sample_queries
import_sample_queries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.import_config.ImportSampleQueriesRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Bulk import of multiple xref_SampleQuerys.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.list_sample_queries
list_sample_queries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesAsyncPager
)
Gets a list of xref_SampleQuerys.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.parse_sample_query_path
parse_sample_query_path(path: str) -> typing.Dict[str, str]
Parses a sample_query path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.sample_query_path
sample_query_path(
project: str, location: str, sample_query_set: str, sample_query: str
) -> str
Returns a fully-qualified sample_query string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceAsyncClient.update_sample_query
update_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.UpdateSampleQueryRequest,
dict,
]
] = None,
*,
sample_query: typing.Optional[
google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
] = 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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
Updates a xref_SampleQuery.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient
SampleQueryServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport]]] = 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 =
Instantiates the sample query service client.
See more: google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.exit
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.create_sample_query
create_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.CreateSampleQueryRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
sample_query: typing.Optional[
google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
] = None,
sample_query_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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
Creates a xref_SampleQuery.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.delete_sample_query
delete_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.DeleteSampleQueryRequest,
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, str]] = ()
) -> None
Deletes a xref_SampleQuery.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.get_sample_query
get_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.GetSampleQueryRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
Gets a xref_SampleQuery.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.import_sample_queries
import_sample_queries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.import_config.ImportSampleQueriesRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Bulk import of multiple xref_SampleQuerys.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.list_sample_queries
list_sample_queries(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesPager
)
Gets a list of xref_SampleQuerys.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.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.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.parse_sample_query_path
parse_sample_query_path(path: str) -> typing.Dict[str, str]
Parses a sample_query path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.sample_query_path
sample_query_path(
project: str, location: str, sample_query_set: str, sample_query: str
) -> str
Returns a fully-qualified sample_query string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1beta.services.sample_query_service.SampleQueryServiceClient.update_sample_query
update_sample_query(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_service.UpdateSampleQueryRequest,
dict,
]
] = None,
*,
sample_query: typing.Optional[
google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
] = 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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
Updates a xref_SampleQuery.
google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesAsyncPager
ListSampleQueriesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesRequest,
response: google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesResponse,
*,
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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesAsyncPager
google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesPager
ListSampleQueriesPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesResponse,
],
request: google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesRequest,
response: google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesPager
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient
SampleQuerySetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the sample query set service async client.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.create_sample_query_set
create_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.CreateSampleQuerySetRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
sample_query_set: typing.Optional[
google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
] = None,
sample_query_set_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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
Creates a xref_SampleQuerySet.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.delete_sample_query_set
delete_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.DeleteSampleQuerySetRequest,
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, str]] = ()
) -> None
Deletes a xref_SampleQuerySet.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.get_sample_query_set
get_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.GetSampleQuerySetRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
Gets a xref_SampleQuerySet.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.list_sample_query_sets
list_sample_query_sets(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.ListSampleQuerySetsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.pagers.ListSampleQuerySetsAsyncPager
)
Gets a list of xref_SampleQuerySets.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceAsyncClient.update_sample_query_set
update_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.UpdateSampleQuerySetRequest,
dict,
]
] = None,
*,
sample_query_set: typing.Optional[
google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
] = 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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
Updates a xref_SampleQuerySet.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient
SampleQuerySetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.sample_query_set_service.transports.base.SampleQuerySetServiceTransport]]] = 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 =
Instantiates the sample query set service client.
See more: google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.create_sample_query_set
create_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.CreateSampleQuerySetRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
sample_query_set: typing.Optional[
google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
] = None,
sample_query_set_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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
Creates a xref_SampleQuerySet.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.delete_sample_query_set
delete_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.DeleteSampleQuerySetRequest,
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, str]] = ()
) -> None
Deletes a xref_SampleQuerySet.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.get_sample_query_set
get_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.GetSampleQuerySetRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
Gets a xref_SampleQuerySet.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.list_sample_query_sets
list_sample_query_sets(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.ListSampleQuerySetsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.pagers.ListSampleQuerySetsPager
)
Gets a list of xref_SampleQuerySets.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.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.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.parse_sample_query_set_path
parse_sample_query_set_path(path: str) -> typing.Dict[str, str]
Parses a sample_query_set path into its component segments.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.sample_query_set_path
sample_query_set_path(project: str, location: str, sample_query_set: str) -> str
Returns a fully-qualified sample_query_set string.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.SampleQuerySetServiceClient.update_sample_query_set
update_sample_query_set(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.UpdateSampleQuerySetRequest,
dict,
]
] = None,
*,
sample_query_set: typing.Optional[
google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
] = 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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query_set.SampleQuerySet
Updates a xref_SampleQuerySet.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.pagers.ListSampleQuerySetsAsyncPager
ListSampleQuerySetsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.ListSampleQuerySetsResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.sample_query_set_service.ListSampleQuerySetsRequest,
response: google.cloud.discoveryengine_v1beta.types.sample_query_set_service.ListSampleQuerySetsResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1beta.services.sample_query_set_service.pagers.ListSampleQuerySetsPager
ListSampleQuerySetsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.sample_query_set_service.ListSampleQuerySetsResponse,
],
request: google.cloud.discoveryengine_v1beta.types.sample_query_set_service.ListSampleQuerySetsRequest,
response: google.cloud.discoveryengine_v1beta.types.sample_query_set_service.ListSampleQuerySetsResponse,
*,
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, str]] = ()
)
Instantiate the pager.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient
SchemaServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.schema_service.transports.base.SchemaServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the schema service async client.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.create_schema
create_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.schema_service.CreateSchemaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schema: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_Schema.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.create_schema
google.cloud.discoveryengine_v1beta.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_v1beta.services.schema_service.SchemaServiceAsyncClient.data_store_path
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.delete_schema
delete_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_Schema.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.delete_schema
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.get_schema
get_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.schema.Schema
Gets a xref_Schema.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.get_schema
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.schema_service.transports.base.SchemaServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.list_operations
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.list_schemas
list_schemas(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.schema_service.pagers.ListSchemasAsyncPager
)
Gets a list of xref_Schemas.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.list_schemas
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.parse_schema_path
parse_schema_path(path: str) -> typing.Dict[str, str]
Parses a schema path into its component segments.
google.cloud.discoveryengine_v1beta.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_v1beta.services.schema_service.SchemaServiceAsyncClient.schema_path
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.update_schema
update_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a xref_Schema.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceAsyncClient.update_schema
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient
SchemaServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.schema_service.transports.base.SchemaServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the schema service client.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.cancel_operation
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.common_folder_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.schema_service.SchemaServiceClient.common_location_path
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.common_project_path
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.create_schema
create_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.schema_service.CreateSchemaRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schema: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_Schema.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.create_schema
google.cloud.discoveryengine_v1beta.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_v1beta.services.schema_service.SchemaServiceClient.data_store_path
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.delete_schema
delete_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_Schema.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.delete_schema
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.get_operation
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.get_schema
get_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.schema.Schema
Gets a xref_Schema.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.get_schema
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.list_operations
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.list_schemas
list_schemas(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.schema_service.pagers.ListSchemasPager
)
Gets a list of xref_Schemas.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.list_schemas
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.schema_service.SchemaServiceClient.parse_schema_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.schema_service.SchemaServiceClient.schema_path
google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.update_schema
update_schema(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Updates a xref_Schema.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.SchemaServiceClient.update_schema
google.cloud.discoveryengine_v1beta.services.schema_service.pagers.ListSchemasAsyncPager
ListSchemasAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.schema_service.ListSchemasResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.schema_service.ListSchemasRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.pagers.ListSchemasAsyncPager
google.cloud.discoveryengine_v1beta.services.schema_service.pagers.ListSchemasPager
ListSchemasPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.schema_service.ListSchemasResponse,
],
request: google.cloud.discoveryengine_v1beta.types.schema_service.ListSchemasRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.schema_service.pagers.ListSchemasPager
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient
SearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the search service async client.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceAsyncClient.branch_path
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceAsyncClient.chunk_path
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceAsyncClient.data_store_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceAsyncClient.document_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.get_operation
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.search_service.transports.base.SearchServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.list_operations
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.parse_branch_path
parse_branch_path(path: str) -> typing.Dict[str, str]
Parses a branch path into its component segments.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.parse_chunk_path
parse_chunk_path(path: str) -> typing.Dict[str, str]
Parses a chunk path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.parse_session_path
parse_session_path(path: str) -> typing.Dict[str, str]
Parses a session path into its component segments.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.search
search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchAsyncPager
)
Performs a search.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceAsyncClient.search
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceAsyncClient.session_path
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient
SearchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the search service client.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.exit
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.branch_path
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.cancel_operation
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.chunk_path
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.common_folder_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.common_location_path
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.common_project_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.data_store_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.document_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.get_operation
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.list_operations
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.parse_branch_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.parse_chunk_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.parse_document_path
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.parse_session_path
google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.search
search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchPager
Performs a search.
See more: google.cloud.discoveryengine_v1beta.services.search_service.SearchServiceClient.search
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.serving_config_path
google.cloud.discoveryengine_v1beta.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_v1beta.services.search_service.SearchServiceClient.session_path
google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchAsyncPager
SearchAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.search_service.SearchResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.search_service.SearchRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiates the pager.
See more: google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchAsyncPager
google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchPager
SearchPager(
method: typing.Callable[
[...], google.cloud.discoveryengine_v1beta.types.search_service.SearchResponse
],
request: google.cloud.discoveryengine_v1beta.types.search_service.SearchRequest,
response: google.cloud.discoveryengine_v1beta.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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchPager
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient
SearchTuningServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.search_tuning_service.transports.base.SearchTuningServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the search tuning service async client.
See more: google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.search_tuning_service.transports.base.SearchTuningServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient.list_custom_models
list_custom_models(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.search_tuning_service.ListCustomModelsResponse
)
Gets a list of all the custom models.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceAsyncClient.train_custom_model
train_custom_model(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Trains a custom model.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient
SearchTuningServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.search_tuning_service.transports.base.SearchTuningServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the search tuning service client.
See more: google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.list_custom_models
list_custom_models(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.types.search_tuning_service.ListCustomModelsResponse
)
Gets a list of all the custom models.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.search_tuning_service.SearchTuningServiceClient.train_custom_model
train_custom_model(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation.Operation
Trains a custom model.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient
ServingConfigServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the serving config service async client.
See more: google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_serving_config
get_serving_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.serving_config_service.GetServingConfigRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.serving_config.ServingConfig
Gets a ServingConfig.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.serving_config_service.transports.base.ServingConfigServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.list_serving_configs
list_serving_configs(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.serving_config_service.ListServingConfigsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.serving_config_service.pagers.ListServingConfigsAsyncPager
)
Lists all ServingConfigs linked to this dataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config
update_serving_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.serving_config_service.UpdateServingConfigRequest,
dict,
]
] = None,
*,
serving_config: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.serving_config.ServingConfig
Updates a ServingConfig.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient
ServingConfigServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the serving config service client.
See more: google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.exit
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.get_serving_config
get_serving_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.serving_config_service.GetServingConfigRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.serving_config.ServingConfig
Gets a ServingConfig.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.list_serving_configs
list_serving_configs(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.serving_config_service.ListServingConfigsRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.serving_config_service.pagers.ListServingConfigsPager
)
Lists all ServingConfigs linked to this dataStore.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.serving_config_service.ServingConfigServiceClient.update_serving_config
update_serving_config(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.serving_config_service.UpdateServingConfigRequest,
dict,
]
] = None,
*,
serving_config: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.serving_config.ServingConfig
Updates a ServingConfig.
google.cloud.discoveryengine_v1beta.services.serving_config_service.pagers.ListServingConfigsAsyncPager
ListServingConfigsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.serving_config_service.ListServingConfigsResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.serving_config_service.ListServingConfigsRequest,
response: google.cloud.discoveryengine_v1beta.types.serving_config_service.ListServingConfigsResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1beta.services.serving_config_service.pagers.ListServingConfigsPager
ListServingConfigsPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.serving_config_service.ListServingConfigsResponse,
],
request: google.cloud.discoveryengine_v1beta.types.serving_config_service.ListServingConfigsRequest,
response: google.cloud.discoveryengine_v1beta.types.serving_config_service.ListServingConfigsResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.serving_config_service.pagers.ListServingConfigsPager
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient
SiteSearchEngineServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.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 =
Instantiates the site search engine service async client.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.batch_create_target_sites
batch_create_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates xref_TargetSite in a batch.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.batch_verify_target_sites
batch_verify_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Verify target sites' ownership and validity.
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.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.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.create_target_site
create_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.CreateTargetSiteRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
target_site: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a xref_TargetSite.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.delete_target_site
delete_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.DeleteTargetSiteRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a xref_TargetSite.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.disable_advanced_site_search
disable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.DisableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Downgrade from advanced site search to basic site search.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.enable_advanced_site_search
enable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.EnableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Upgrade from basic site search to advanced site search.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.fetch_domain_verification_status
fetch_domain_verification_status(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager
)
Returns list of target sites with its domain verification status.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_site_search_engine
get_site_search_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.GetSiteSearchEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.site_search_engine.SiteSearchEngine
Gets the xref_SiteSearchEngine.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_target_site
get_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.GetTargetSiteRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.site_search_engine.TargetSite
Gets a xref_TargetSite.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.list_target_sites
list_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.ListTargetSitesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager
)
Gets a list of xref_TargetSites.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_site_search_engine_path
parse_site_search_engine_path(path: str) -> typing.Dict[str, str]
Parses a site_search_engine path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.parse_target_site_path
parse_target_site_path(path: str) -> typing.Dict[str, str]
Parses a target_site path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.recrawl_uris
recrawl_uris(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.RecrawlUrisRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Request on-demand recrawl for a list of URIs.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.site_search_engine_path
site_search_engine_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified site_search_engine string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.target_site_path
target_site_path(
project: str, location: str, data_store: str, target_site: str
) -> str
Returns a fully-qualified target_site string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceAsyncClient.update_target_site
update_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.UpdateTargetSiteRequest,
dict,
]
] = None,
*,
target_site: typing.Optional[
google.cloud.discoveryengine_v1beta.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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a xref_TargetSite.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient
SiteSearchEngineServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.site_search_engine_service.transports.base.SiteSearchEngineServiceTransport]]] = 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 =
Instantiates the site search engine service client.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.batch_create_target_sites
batch_create_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.BatchCreateTargetSitesRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Creates xref_TargetSite in a batch.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.batch_verify_target_sites
batch_verify_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.BatchVerifyTargetSitesRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Verify target sites' ownership and validity.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.create_target_site
create_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.CreateTargetSiteRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
target_site: typing.Optional[
google.cloud.discoveryengine_v1beta.types.site_search_engine.TargetSite
] = 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, str]] = ()
) -> google.api_core.operation.Operation
Creates a xref_TargetSite.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.delete_target_site
delete_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.DeleteTargetSiteRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Deletes a xref_TargetSite.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.disable_advanced_site_search
disable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.DisableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Downgrade from advanced site search to basic site search.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.enable_advanced_site_search
enable_advanced_site_search(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.EnableAdvancedSiteSearchRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Upgrade from basic site search to advanced site search.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.fetch_domain_verification_status
fetch_domain_verification_status(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager
)
Returns list of target sites with its domain verification status.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.get_site_search_engine
get_site_search_engine(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.GetSiteSearchEngineRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.site_search_engine.SiteSearchEngine
Gets the xref_SiteSearchEngine.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.get_target_site
get_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.GetTargetSiteRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.site_search_engine.TargetSite
Gets a xref_TargetSite.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.list_target_sites
list_target_sites(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.ListTargetSitesRequest,
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, str]] = ()
) -> (
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.ListTargetSitesPager
)
Gets a list of xref_TargetSites.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.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.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_site_search_engine_path
parse_site_search_engine_path(path: str) -> typing.Dict[str, str]
Parses a site_search_engine path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.parse_target_site_path
parse_target_site_path(path: str) -> typing.Dict[str, str]
Parses a target_site path into its component segments.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.recrawl_uris
recrawl_uris(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.RecrawlUrisRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Request on-demand recrawl for a list of URIs.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.site_search_engine_path
site_search_engine_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified site_search_engine string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.target_site_path
target_site_path(
project: str, location: str, data_store: str, target_site: str
) -> str
Returns a fully-qualified target_site string.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.SiteSearchEngineServiceClient.update_target_site
update_target_site(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.UpdateTargetSiteRequest,
dict,
]
] = None,
*,
target_site: typing.Optional[
google.cloud.discoveryengine_v1beta.types.site_search_engine.TargetSite
] = 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, str]] = ()
) -> google.api_core.operation.Operation
Updates a xref_TargetSite.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager
FetchDomainVerificationStatusAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.FetchDomainVerificationStatusResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
response: google.cloud.discoveryengine_v1beta.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager
FetchDomainVerificationStatusPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
],
request: google.cloud.discoveryengine_v1beta.types.site_search_engine_service.FetchDomainVerificationStatusRequest,
response: google.cloud.discoveryengine_v1beta.types.site_search_engine_service.FetchDomainVerificationStatusResponse,
*,
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, str]] = ()
)
Instantiate the pager.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager
ListTargetSitesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.ListTargetSitesResponse
],
],
request: google.cloud.discoveryengine_v1beta.types.site_search_engine_service.ListTargetSitesRequest,
response: google.cloud.discoveryengine_v1beta.types.site_search_engine_service.ListTargetSitesResponse,
*,
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, str]] = ()
)
Instantiates the pager.
google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.ListTargetSitesPager
ListTargetSitesPager(
method: typing.Callable[
[...],
google.cloud.discoveryengine_v1beta.types.site_search_engine_service.ListTargetSitesResponse,
],
request: google.cloud.discoveryengine_v1beta.types.site_search_engine_service.ListTargetSitesRequest,
response: google.cloud.discoveryengine_v1beta.types.site_search_engine_service.ListTargetSitesResponse,
*,
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, str]] = ()
)
Instantiate the pager.
See more: google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.ListTargetSitesPager
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient
UserEventServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.user_event_service.transports.base.UserEventServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the user event service async client.
See more: google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.collect_user_event
collect_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.user_event_service.CollectUserEventRequest,
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, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Writes a single user event from the browser.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.document_path
document_path(
project: str, location: str, data_store: str, branch: str, document: str
) -> str
Returns a fully-qualified document string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.engine_path
engine_path(project: str, location: str, collection: str, engine: str) -> str
Returns a fully-qualified engine string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.discoveryengine_v1beta.services.user_event_service.transports.base.UserEventServiceTransport
]
Returns an appropriate transport class.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.import_user_events
import_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.import_config.ImportUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Bulk import of user events.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.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.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.purge_user_events
purge_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.purge_config.PurgeUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes permanently all user events specified by the filter provided.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceAsyncClient.write_user_event
write_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.user_event_service.WriteUserEventRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.user_event.UserEvent
Writes a single user event.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient
UserEventServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.user_event_service.transports.base.UserEventServiceTransport]]] = 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 =
Instantiates the user event service client.
See more: google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.exit
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.collect_user_event
collect_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.user_event_service.CollectUserEventRequest,
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, str]] = ()
) -> google.api.httpbody_pb2.HttpBody
Writes a single user event from the browser.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.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_v1beta.services.user_event_service.UserEventServiceClient.document_path
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.engine_path
engine_path(project: str, location: str, collection: str, engine: str) -> str
Returns a fully-qualified engine string.
See more: google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.engine_path
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.get_operation
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.import_user_events
import_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.import_config.ImportUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Bulk import of user events.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.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, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.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.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.parse_engine_path
parse_engine_path(path: str) -> typing.Dict[str, str]
Parses a engine path into its component segments.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.purge_user_events
purge_user_events(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.purge_config.PurgeUserEventsRequest,
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, str]] = ()
) -> google.api_core.operation.Operation
Deletes permanently all user events specified by the filter provided.
google.cloud.discoveryengine_v1beta.services.user_event_service.UserEventServiceClient.write_user_event
write_user_event(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.user_event_service.WriteUserEventRequest,
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, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.user_event.UserEvent
Writes a single user event.