0.20.1 (latest) 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.12 0.12.3 0.11.14 0.10.0 0.9.1 0.8.1 0.7.0 0.6.0 0.5.0 0.4.1 0.3.1 0.2.1 0.1.1 UserStoreServiceAsyncClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.discoveryengine_v1beta.services.user_store_service.transports.base.UserStoreServiceTransport, typing.Callable[ [...], google.cloud.discoveryengine_v1beta.services.user_store_service.transports.base.UserStoreServiceTransport, ], ] ] = "grpc_asyncio", client_options: typing.Optional[ google.api_core.client_options.ClientOptions ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Service for managing User Stores. ## Properties ### api_endpoint Return the API endpoint used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The API endpoint used by the client instance. | ### transport Returns the transport used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `UserStoreServiceTransport` | The transport used by the client instance. | ### universe_domain Return the universe domain used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The universe domain used by the client instance. | ## Methods ### UserStoreServiceAsyncClient UserStoreServiceAsyncClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.discoveryengine_v1beta.services.user_store_service.transports.base.UserStoreServiceTransport, typing.Callable[ [...], google.cloud.discoveryengine_v1beta.services.user_store_service.transports.base.UserStoreServiceTransport, ], ] ] = "grpc_asyncio", client_options: typing.Optional[ google.api_core.client_options.ClientOptions ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Instantiates the user store service async client. | **Parameters** || |---|---| | **Name** | **Description** | | `credentials` | `Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. | | `transport` | `Optional[Union[str,UserStoreServiceTransport,Callable[..., UserStoreServiceTransport]]]` The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the UserStoreServiceTransport constructor. If set to None, a transport is chosen automatically. | | `client_options` | `Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS. | | `client_info` | `google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library. | | **Exceptions** || |---|---| | **Type** | **Description** | | `google.auth.exceptions.MutualTlsChannelError` | If mutual TLS transport creation failed for any reason. | ### cancel_operation cancel_operation( request: typing.Optional[ typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.operations_pb2.CancelOperationRequest` `` The request object. Request message for `CancelOperation` method. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### common_billing_account_path common_billing_account_path(billing_account: str) -> str Returns a fully-qualified billing_account string. ### common_folder_path common_folder_path(folder: str) -> str Returns a fully-qualified folder string. ### common_location_path common_location_path(project: str, location: str) -> str Returns a fully-qualified location string. ### common_organization_path common_organization_path(organization: str) -> str Returns a fully-qualified organization string. ### common_project_path common_project_path(project: str) -> str Returns a fully-qualified project string. ### from_service_account_file from_service_account_file(filename: str, *args, **kwargs) Creates an instance of this client using the provided credentials file. | **Parameter** || |---|---| | **Name** | **Description** | | `filename` | `str` The path to the service account private key json file. | | **Returns** || |---|---| | **Type** | **Description** | | `UserStoreServiceAsyncClient` | The constructed client. | ### from_service_account_info from_service_account_info(info: dict, *args, **kwargs) Creates an instance of this client using the provided credentials info. | **Parameter** || |---|---| | **Name** | **Description** | | `info` | `dict` The service account private key info. | | **Returns** || |---|---| | **Type** | **Description** | | `UserStoreServiceAsyncClient` | The constructed client. | ### from_service_account_json from_service_account_json(filename: str, *args, **kwargs) Creates an instance of this client using the provided credentials file. | **Parameter** || |---|---| | **Name** | **Description** | | `filename` | `str` The path to the service account private key json file. | | **Returns** || |---|---| | **Type** | **Description** | | `UserStoreServiceAsyncClient` | The constructed client. | ### 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. The client cert source is determined in the following order: (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the client cert source is None. (2) if `client_options.client_cert_source` is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None. The API endpoint is determined in the following order: (1) if `client_options.api_endpoint` if provided, use the provided one. (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint. More details can be found at . | **Parameter** || |---|---| | **Name** | **Description** | | `client_options` | `google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method. | | **Exceptions** || |---|---| | **Type** | **Description** | | `google.auth.exceptions.MutualTLSChannelError` | If any errors happen. | | **Returns** || |---|---| | **Type** | **Description** | | `Tuple[str, Callable[[], Tuple[bytes, bytes]]]` | returns the API endpoint and the client cert source to use. | ### get_operation get_operation( request: typing.Optional[ typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.longrunning.operations_pb2.Operation Gets the latest state of a long-running operation. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.operations_pb2.GetOperationRequest` `` The request object. Request message for `GetOperation` method. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.operations_pb2.Operation` `` | An `Operation` object. | ### get_transport_class get_transport_class( label: typing.Optional[str] = None, ) -> typing.Type[ google.cloud.discoveryengine_v1beta.services.user_store_service.transports.base.UserStoreServiceTransport ] Returns an appropriate transport class. | **Parameter** || |---|---| | **Name** | **Description** | | `label` | `typing.Optional[str]` The name of the desired transport. If none is provided, then the first transport in the registry is used. | ### get_user_store get_user_store( request: typing.Optional[ typing.Union[ google.cloud.discoveryengine_v1beta.types.user_store_service.GetUserStoreRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.discoveryengine_v1beta.types.user_store.UserStore Gets the User Store. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import discoveryengine_v1beta async def sample_get_user_store(): # Create a client client = discoveryengine_v1beta.https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.services.user_store_service.UserStoreServiceAsyncClient.html() # Initialize request argument(s) request = discoveryengine_v1beta.https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.GetUserStoreRequest.html( name="name_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.services.user_store_service.UserStoreServiceAsyncClient.html#google_cloud_discoveryengine_v1beta_services_user_store_service_UserStoreServiceAsyncClient_get_user_store(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.GetUserStoreRequest, dict]]` The request object. Request message for UserStoreService.GetUserStore | | `name` | `` `str` `` Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.UserStore` | Configures metadata that is used for End User entities. | ### license_config_path license_config_path(project: str, location: str, license_config: str) -> str Returns a fully-qualified license_config string. ### list_operations list_operations( request: typing.Optional[ typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.longrunning.operations_pb2.ListOperationsResponse Lists operations that match the specified filter in the request. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.operations_pb2.ListOperationsRequest` `` The request object. Request message for `ListOperations` method. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.operations_pb2.ListOperationsResponse` `` | Response message for `ListOperations` method. | ### 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. ### parse_common_folder_path parse_common_folder_path(path: str) -> typing.Dict[str, str] Parse a folder path into its component segments. ### parse_common_location_path parse_common_location_path(path: str) -> typing.Dict[str, str] Parse a location path into its component segments. ### parse_common_organization_path parse_common_organization_path(path: str) -> typing.Dict[str, str] Parse a organization path into its component segments. ### parse_common_project_path parse_common_project_path(path: str) -> typing.Dict[str, str] Parse a project path into its component segments. ### parse_license_config_path parse_license_config_path(path: str) -> typing.Dict[str, str] Parses a license_config path into its component segments. ### parse_user_store_path parse_user_store_path(path: str) -> typing.Dict[str, str] Parses a user_store path into its component segments. ### update_user_store update_user_store( request: typing.Optional[ typing.Union[ google.cloud.discoveryengine_v1beta.types.user_store_service.UpdateUserStoreRequest, dict, ] ] = None, *, user_store: typing.Optional[ google.cloud.discoveryengine_v1beta.types.user_store.UserStore ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.discoveryengine_v1beta.types.user_store.UserStore Updates the User Store. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import discoveryengine_v1beta async def sample_update_user_store(): # Create a client client = discoveryengine_v1beta.https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.services.user_store_service.UserStoreServiceAsyncClient.html() # Initialize request argument(s) request = discoveryengine_v1beta.https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.UpdateUserStoreRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.services.user_store_service.UserStoreServiceAsyncClient.html#google_cloud_discoveryengine_v1beta_services_user_store_service_UserStoreServiceAsyncClient_update_user_store(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.UpdateUserStoreRequest, dict]]` The request object. Request message for UserStoreService.UpdateUserStore method. | | `user_store` | `https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.UserStore` Required. The User Store to update. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` This corresponds to the `user_store` field on the `request` instance; if `request` is provided, this should not be set. | | `update_mask` | `` `google.protobuf.field_mask_pb2.FieldMask` `` Optional. The list of fields to update. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.UserStore` | Configures metadata that is used for End User entities. | ### user_store_path user_store_path(project: str, location: str, user_store: str) -> str Returns a fully-qualified user_store string.