Class ProjectServiceAsyncClient (1.21.1)

ProjectServiceAsyncClient(*, 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]]] = '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 object>)

Service for settings at Project level.

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
ProjectServiceTransport 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

ProjectServiceAsyncClient

ProjectServiceAsyncClient(*, 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]]] = '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 object>)

Instantiates the project 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,ProjectServiceTransport,Callable[..., ProjectServiceTransport]]]

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 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 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.

accept_terms

accept_terms(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.project_service.AcceptTermsRequest, dict
        ]
    ] = None,
    *,
    project: 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.retail_v2alpha.types.project.Project

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

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

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[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_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
Type Description
google.cloud.retail_v2alpha.types.Project Metadata that describes a Cloud Retail Project.

alert_config_path

alert_config_path(project: str) -> str

Returns a fully-qualified alert_config string.

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.

enroll_solution

enroll_solution(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.project_service.EnrollSolutionRequest,
            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

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
Name Description
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
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be EnrollSolutionResponse Response for EnrollSolution method.

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
ProjectServiceAsyncClient 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
ProjectServiceAsyncClient 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
ProjectServiceAsyncClient The constructed client.

get_alert_config

get_alert_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.project_service.GetAlertConfigRequest,
            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.retail_v2alpha.types.project.AlertConfig

Get the xref_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
Name Description
request Optional[Union[google.cloud.retail_v2alpha.types.GetAlertConfigRequest, dict]]

The request object. Request for 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
Type Description
google.cloud.retail_v2alpha.types.AlertConfig Project level alert config.

get_logging_config

get_logging_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.project_service.GetLoggingConfigRequest,
            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.retail_v2alpha.types.project.LoggingConfig

Gets the xref_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
Name Description
request Optional[Union[google.cloud.retail_v2alpha.types.GetLoggingConfigRequest, dict]]

The request object. Request for 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
Type Description
google.cloud.retail_v2alpha.types.LoggingConfig Project level logging config to control what level of log will be generated and written to Cloud Logging.

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

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[
        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.

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, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.operations_pb2.Operation An Operation object.

get_project

get_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.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.retail_v2alpha.types.project.Project

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
Name Description
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
Type Description
google.cloud.retail_v2alpha.types.Project Metadata that describes a Cloud Retail Project.

get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2alpha.services.project_service.transports.base.ProjectServiceTransport
    ]
)

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.

list_enrolled_solutions

list_enrolled_solutions(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.project_service.ListEnrolledSolutionsRequest,
            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.retail_v2alpha.types.project_service.ListEnrolledSolutionsResponse

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
Name Description
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
Type Description
google.cloud.retail_v2alpha.types.ListEnrolledSolutionsResponse Response for ListEnrolledSolutions method.

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.

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, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

logging_config_path

logging_config_path(project: str) -> str

Returns a fully-qualified logging_config string.

parse_alert_config_path

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

Parses a alert_config path into its component segments.

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_logging_config_path

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

Parses a logging_config path into its component segments.

parse_retail_project_path

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

Parses a retail_project path into its component segments.

retail_project_path

retail_project_path(project: str) -> str

Returns a fully-qualified retail_project string.

update_alert_config

update_alert_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.project_service.UpdateAlertConfigRequest,
            dict,
        ]
    ] = None,
    *,
    alert_config: typing.Optional[
        google.cloud.retail_v2alpha.types.project.AlertConfig
    ] = 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.retail_v2alpha.types.project.AlertConfig

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
Name Description
request Optional[Union[google.cloud.retail_v2alpha.types.UpdateAlertConfigRequest, dict]]

The request object. Request for ProjectService.UpdateAlertConfig method.

alert_config AlertConfig

Required. The AlertConfig to update. If the caller does not have permission to update the AlertConfig, then a PERMISSION_DENIED error is returned. If the 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 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
Type Description
google.cloud.retail_v2alpha.types.AlertConfig Project level alert config.

update_logging_config

update_logging_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.project_service.UpdateLoggingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    logging_config: typing.Optional[
        google.cloud.retail_v2alpha.types.project.LoggingConfig
    ] = 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.retail_v2alpha.types.project.LoggingConfig

Updates the xref_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
Name Description
request Optional[Union[google.cloud.retail_v2alpha.types.UpdateLoggingConfigRequest, dict]]

The request object. Request for ProjectService.UpdateLoggingConfig method.

logging_config LoggingConfig

Required. The LoggingConfig to update. If the caller does not have permission to update the LoggingConfig, then a PERMISSION_DENIED error is returned. If the 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 to update. The following are the only supported fields: - LoggingConfig.default_log_generation_rule - 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
Type Description
google.cloud.retail_v2alpha.types.LoggingConfig Project level logging config to control what level of log will be generated and written to Cloud Logging.