ProjectService¶

google.api_core.operation_async.AsyncOperation

static alert_config_path(project: str) → str¶: Returns a fully-qualified alert_config string.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async enroll_solution(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.EnrollSolutionRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

The method enrolls a solution of type [Retail Search][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH] into a project.

The [Recommendations AI solution type][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION] is enrolled by default when your project enables Retail API, so you don’t need to call the enrollSolution method for recommendations.

# 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 retail_v2alpha

async def sample_enroll_solution():
    # Create a client
    client = retail_v2alpha.ProjectServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.EnrollSolutionRequest(
        project="project_value",
        solution="SOLUTION_TYPE_SEARCH",
    )

    # Make the request
    operation = client.enroll_solution(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.EnrollSolutionRequest, dict]]) – The request object. Request for EnrollSolution 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2alpha.types.EnrollSolutionResponse Response for EnrollSolution method.

Return type

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ProjectServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ProjectServiceAsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ProjectServiceAsyncClient

async get_alert_config(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.GetAlertConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.AlertConfig[source]¶

Get the [AlertConfig][google.cloud.retail.v2alpha.AlertConfig] of the requested project.

# 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 retail_v2alpha

async def sample_get_alert_config():
    # Create a client
    client = retail_v2alpha.ProjectServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetAlertConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_alert_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.GetAlertConfigRequest, dict]]) – The request object. Request for [ProjectService.GetAlertConfig][google.cloud.retail.v2alpha.ProjectService.GetAlertConfig] method.
name (str) –
Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig

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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Project level alert config.

Return type

async get_logging_config(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.GetLoggingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.LoggingConfig[source]¶

Gets the [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] of the requested project.

# 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 retail_v2alpha

async def sample_get_logging_config():
    # Create a client
    client = retail_v2alpha.ProjectServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetLoggingConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_logging_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.GetLoggingConfigRequest, dict]]) – The request object. Request for [ProjectService.GetLoggingConfig][google.cloud.retail.v2alpha.ProjectService.GetLoggingConfig] method.
name (str) –
Required. Full LoggingConfig resource name. Format: projects/{project_number}/loggingConfig

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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Project level logging config to control what level of log will be generated and written to Cloud Logging.

Return type

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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 https://google.aip.dev/auth/4114.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

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

Gets the latest state of a long-running operation.

Parameters

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

async get_project(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.GetProjectRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.Project[source]¶

Gets the project.

Throws NOT_FOUND if the project wasn’t initialized for the Retail API service.

# 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 retail_v2alpha

async def sample_get_project():
    # Create a client
    client = retail_v2alpha.ProjectServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetProjectRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_project(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.GetProjectRequest, dict]]) – The request object. Request for GetProject method.
name (str) –
Required. Full resource name of the project. Format: projects/{project_number_or_id}/retailProject

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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Metadata that describes a Cloud Retail Project.

Return type

google.cloud.retail_v2alpha.types.ListEnrolledSolutionsResponse

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.retail_v2alpha.services.project_service.transports.base.ProjectServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_enrolled_solutions(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.ListEnrolledSolutionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project_service.ListEnrolledSolutionsResponse[source]¶

Lists all the retail API solutions the project has enrolled.

# 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 retail_v2alpha

async def sample_list_enrolled_solutions():
    # Create a client
    client = retail_v2alpha.ProjectServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.ListEnrolledSolutionsRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.list_enrolled_solutions(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.ListEnrolledSolutionsRequest, dict]]) – The request object. Request for ListEnrolledSolutions method.
parent (str) –
Required. Full resource name of parent. Format: projects/{project_number_or_id}

This corresponds to the parent 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for ListEnrolledSolutions method.

Return type

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

Lists operations that match the specified filter in the request.

Parameters

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

static logging_config_path(project: str) → str¶: Returns a fully-qualified logging_config string.

static parse_alert_config_path(path: str) → Dict[str, str]¶: Parses a alert_config path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_logging_config_path(path: str) → Dict[str, str]¶: Parses a logging_config path into its component segments.

static parse_retail_project_path(path: str) → Dict[str, str]¶: Parses a retail_project path into its component segments.

static retail_project_path(project: str) → str¶: Returns a fully-qualified retail_project string.

property transport: google.cloud.retail_v2alpha.services.project_service.transports.base.ProjectServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: ProjectServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_alert_config(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.UpdateAlertConfigRequest, dict]] = None, *, alert_config: Optional[google.cloud.retail_v2alpha.types.project.AlertConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.AlertConfig[source]¶

Update the alert config of the requested project.

# 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 retail_v2alpha

async def sample_update_alert_config():
    # Create a client
    client = retail_v2alpha.ProjectServiceAsyncClient()

    # Initialize request argument(s)
    alert_config = retail_v2alpha.AlertConfig()
    alert_config.name = "name_value"

    request = retail_v2alpha.UpdateAlertConfigRequest(
        alert_config=alert_config,
    )

    # Make the request
    response = await client.update_alert_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.UpdateAlertConfigRequest, dict]]) – The request object. Request for [ProjectService.UpdateAlertConfig][google.cloud.retail.v2alpha.ProjectService.UpdateAlertConfig] method.
alert_config (google.cloud.retail_v2alpha.types.AlertConfig) –
Required. The [AlertConfig][google.cloud.retail.v2alpha.AlertConfig] to update.

If the caller does not have permission to update the [AlertConfig][google.cloud.retail.v2alpha.AlertConfig], then a PERMISSION_DENIED error is returned.

If the [AlertConfig][google.cloud.retail.v2alpha.AlertConfig] to update does not exist, a NOT_FOUND error is returned.

This corresponds to the alert_config field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Indicates which fields in the provided [AlertConfig][google.cloud.retail.v2alpha.AlertConfig] to update. If not set, all supported fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Project level alert config.

Return type

async update_logging_config(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.UpdateLoggingConfigRequest, dict]] = None, *, logging_config: Optional[google.cloud.retail_v2alpha.types.project.LoggingConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.LoggingConfig[source]¶

Updates the [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] of the requested project.

# 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 retail_v2alpha

async def sample_update_logging_config():
    # Create a client
    client = retail_v2alpha.ProjectServiceAsyncClient()

    # Initialize request argument(s)
    logging_config = retail_v2alpha.LoggingConfig()
    logging_config.name = "name_value"

    request = retail_v2alpha.UpdateLoggingConfigRequest(
        logging_config=logging_config,
    )

    # Make the request
    response = await client.update_logging_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.UpdateLoggingConfigRequest, dict]]) – The request object. Request for [ProjectService.UpdateLoggingConfig][google.cloud.retail.v2alpha.ProjectService.UpdateLoggingConfig] method.
logging_config (google.cloud.retail_v2alpha.types.LoggingConfig) –
Required. The [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] to update.

If the caller does not have permission to update the [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig], then a PERMISSION_DENIED error is returned.

If the [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] to update does not exist, a NOT_FOUND error is returned.

This corresponds to the logging_config field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Indicates which fields in the provided [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] to update. The following are the only supported fields:
- [LoggingConfig.default_log_generation_rule][google.cloud.retail.v2alpha.LoggingConfig.default_log_generation_rule]
- [LoggingConfig.service_log_generation_rules][google.cloud.retail.v2alpha.LoggingConfig.service_log_generation_rules]
If not set, all supported fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Project level logging config to control what level of log will be generated and written to Cloud Logging.

Return type

class google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.project_service.transports.base.ProjectServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.project_service.transports.base.ProjectServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Service for settings at Project level.

Instantiates the project service client.

Parameters

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,ProjectServiceTransport,Callable[..., ProjectServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the ProjectServiceTransport 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 the 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

accept_terms(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.AcceptTermsRequest, dict]] = None, *, project: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.Project[source]¶

Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms

# 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 retail_v2alpha

def sample_accept_terms():
    # Create a client
    client = retail_v2alpha.ProjectServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.AcceptTermsRequest(
        project="project_value",
    )

    # Make the request
    response = client.accept_terms(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.AcceptTermsRequest, dict]) – The request object. Request for AcceptTerms method.
project (str) –
Required. Full resource name of the project. Format: projects/{project_number_or_id}/retailProject

This corresponds to the project field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Metadata that describes a Cloud Retail Project.

Return type

google.api_core.operation.Operation

static alert_config_path(project: str) → str[source]¶: Returns a fully-qualified alert_config string.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

enroll_solution(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.EnrollSolutionRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

The method enrolls a solution of type [Retail Search][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH] into a project.

The [Recommendations AI solution type][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION] is enrolled by default when your project enables Retail API, so you don’t need to call the enrollSolution method for recommendations.

# 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 retail_v2alpha

def sample_enroll_solution():
    # Create a client
    client = retail_v2alpha.ProjectServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.EnrollSolutionRequest(
        project="project_value",
        solution="SOLUTION_TYPE_SEARCH",
    )

    # Make the request
    operation = client.enroll_solution(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.EnrollSolutionRequest, dict]) – The request object. Request for EnrollSolution method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.retail_v2alpha.types.EnrollSolutionResponse Response for EnrollSolution method.

Return type

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ProjectServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ProjectServiceClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ProjectServiceClient

get_alert_config(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.GetAlertConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.AlertConfig[source]¶

Get the [AlertConfig][google.cloud.retail.v2alpha.AlertConfig] of the requested project.

# 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 retail_v2alpha

def sample_get_alert_config():
    # Create a client
    client = retail_v2alpha.ProjectServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetAlertConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_alert_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.GetAlertConfigRequest, dict]) – The request object. Request for [ProjectService.GetAlertConfig][google.cloud.retail.v2alpha.ProjectService.GetAlertConfig] method.
name (str) –
Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Project level alert config.

Return type

get_logging_config(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.GetLoggingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.LoggingConfig[source]¶

Gets the [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] of the requested project.

# 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 retail_v2alpha

def sample_get_logging_config():
    # Create a client
    client = retail_v2alpha.ProjectServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetLoggingConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_logging_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.GetLoggingConfigRequest, dict]) – The request object. Request for [ProjectService.GetLoggingConfig][google.cloud.retail.v2alpha.ProjectService.GetLoggingConfig] method.
name (str) –
Required. Full LoggingConfig resource name. Format: projects/{project_number}/loggingConfig

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Project level logging config to control what level of log will be generated and written to Cloud Logging.

Return type

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. 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 https://google.aip.dev/auth/4114.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

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

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

get_project(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.GetProjectRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.Project[source]¶

Gets the project.

Throws NOT_FOUND if the project wasn’t initialized for the Retail API service.

# 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 retail_v2alpha

def sample_get_project():
    # Create a client
    client = retail_v2alpha.ProjectServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetProjectRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_project(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.GetProjectRequest, dict]) – The request object. Request for GetProject method.
name (str) –
Required. Full resource name of the project. Format: projects/{project_number_or_id}/retailProject

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Metadata that describes a Cloud Retail Project.

Return type

google.cloud.retail_v2alpha.types.ListEnrolledSolutionsResponse

list_enrolled_solutions(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.ListEnrolledSolutionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project_service.ListEnrolledSolutionsResponse[source]¶

Lists all the retail API solutions the project has enrolled.

# 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 retail_v2alpha

def sample_list_enrolled_solutions():
    # Create a client
    client = retail_v2alpha.ProjectServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.ListEnrolledSolutionsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_enrolled_solutions(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.ListEnrolledSolutionsRequest, dict]) – The request object. Request for ListEnrolledSolutions method.
parent (str) –
Required. Full resource name of parent. Format: projects/{project_number_or_id}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for ListEnrolledSolutions method.

Return type

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

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

static logging_config_path(project: str) → str[source]¶: Returns a fully-qualified logging_config string.

static parse_alert_config_path(path: str) → Dict[str, str][source]¶: Parses a alert_config path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_logging_config_path(path: str) → Dict[str, str][source]¶: Parses a logging_config path into its component segments.

static parse_retail_project_path(path: str) → Dict[str, str][source]¶: Parses a retail_project path into its component segments.

static retail_project_path(project: str) → str[source]¶: Returns a fully-qualified retail_project string.

property transport: google.cloud.retail_v2alpha.services.project_service.transports.base.ProjectServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

ProjectServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_alert_config(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.UpdateAlertConfigRequest, dict]] = None, *, alert_config: Optional[google.cloud.retail_v2alpha.types.project.AlertConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.AlertConfig[source]¶

Update the alert config of the requested project.

# 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 retail_v2alpha

def sample_update_alert_config():
    # Create a client
    client = retail_v2alpha.ProjectServiceClient()

    # Initialize request argument(s)
    alert_config = retail_v2alpha.AlertConfig()
    alert_config.name = "name_value"

    request = retail_v2alpha.UpdateAlertConfigRequest(
        alert_config=alert_config,
    )

    # Make the request
    response = client.update_alert_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.UpdateAlertConfigRequest, dict]) – The request object. Request for [ProjectService.UpdateAlertConfig][google.cloud.retail.v2alpha.ProjectService.UpdateAlertConfig] method.
alert_config (google.cloud.retail_v2alpha.types.AlertConfig) –
Required. The [AlertConfig][google.cloud.retail.v2alpha.AlertConfig] to update.

If the caller does not have permission to update the [AlertConfig][google.cloud.retail.v2alpha.AlertConfig], then a PERMISSION_DENIED error is returned.

If the [AlertConfig][google.cloud.retail.v2alpha.AlertConfig] to update does not exist, a NOT_FOUND error is returned.

This corresponds to the alert_config field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Indicates which fields in the provided [AlertConfig][google.cloud.retail.v2alpha.AlertConfig] to update. If not set, all supported fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Project level alert config.

Return type

update_logging_config(request: Optional[Union[google.cloud.retail_v2alpha.types.project_service.UpdateLoggingConfigRequest, dict]] = None, *, logging_config: Optional[google.cloud.retail_v2alpha.types.project.LoggingConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.project.LoggingConfig[source]¶

Updates the [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] of the requested project.

# 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 retail_v2alpha

def sample_update_logging_config():
    # Create a client
    client = retail_v2alpha.ProjectServiceClient()

    # Initialize request argument(s)
    logging_config = retail_v2alpha.LoggingConfig()
    logging_config.name = "name_value"

    request = retail_v2alpha.UpdateLoggingConfigRequest(
        logging_config=logging_config,
    )

    # Make the request
    response = client.update_logging_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.UpdateLoggingConfigRequest, dict]) – The request object. Request for [ProjectService.UpdateLoggingConfig][google.cloud.retail.v2alpha.ProjectService.UpdateLoggingConfig] method.
logging_config (google.cloud.retail_v2alpha.types.LoggingConfig) –
Required. The [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] to update.

If the caller does not have permission to update the [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig], then a PERMISSION_DENIED error is returned.

If the [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] to update does not exist, a NOT_FOUND error is returned.

This corresponds to the logging_config field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Indicates which fields in the provided [LoggingConfig][google.cloud.retail.v2alpha.LoggingConfig] to update. The following are the only supported fields:
- [LoggingConfig.default_log_generation_rule][google.cloud.retail.v2alpha.LoggingConfig.default_log_generation_rule]
- [LoggingConfig.service_log_generation_rules][google.cloud.retail.v2alpha.LoggingConfig.service_log_generation_rules]
If not set, all supported fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Project level logging config to control what level of log will be generated and written to Cloud Logging.

Return type