Package Methods (1.21.1)

Summary of entries of Methods for retail.

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient

AnalyticsServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.analytics_service.transports.base.AnalyticsServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.analytics_service.transports.base.AnalyticsServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the analytics service async client.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_folder_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_location_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_organization_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.common_project_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.export_analytics_metrics

export_analytics_metrics(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.export_config.ExportAnalyticsMetricsRequest,
            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

Exports analytics metrics.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.export_analytics_metrics

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_file

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_info

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_json

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.get_operation

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.analytics_service.transports.base.AnalyticsServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.get_transport_class

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.list_operations

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient

AnalyticsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.analytics_service.transports.base.AnalyticsServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.analytics_service.transports.base.AnalyticsServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the analytics service client.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.exit

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_billing_account_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_folder_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_location_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_organization_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.common_project_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.export_analytics_metrics

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

Exports analytics metrics.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.export_analytics_metrics

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.from_service_account_file

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.from_service_account_info

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.from_service_account_json

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.get_operation

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.list_operations

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_billing_account_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_folder_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_location_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_organization_path

google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.analytics_service.AnalyticsServiceClient.parse_common_project_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient

CatalogServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.catalog_service.transports.base.CatalogServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.catalog_service.transports.base.CatalogServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the catalog service async client.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.add_catalog_attribute

add_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.AddCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.AttributesConfig

Adds the specified xref_CatalogAttribute to the xref_AttributesConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.add_catalog_attribute

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.attributes_config_path

attributes_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified attributes_config string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.attributes_config_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.branch_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.catalog_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_folder_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_location_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_organization_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.common_project_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.completion_config_path

completion_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified completion_config string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.completion_config_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.from_service_account_file

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.from_service_account_info

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.from_service_account_json

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_attributes_config

get_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.GetAttributesConfigRequest,
            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_v2.types.catalog.AttributesConfig

Gets an xref_AttributesConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_attributes_config

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_completion_config

get_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.GetCompletionConfigRequest,
            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_v2.types.catalog.CompletionConfig

Gets a xref_CompletionConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_completion_config

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_default_branch

get_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.GetDefaultBranchRequest, dict
        ]
    ] = None,
    *,
    catalog: 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_v2.types.catalog_service.GetDefaultBranchResponse

Get which branch is currently default branch set by xref_CatalogService.SetDefaultBranch method under a specified parent catalog.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_default_branch

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_operation

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.catalog_service.transports.base.CatalogServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.get_transport_class

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.list_catalogs

list_catalogs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.ListCatalogsRequest, 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_v2.services.catalog_service.pagers.ListCatalogsAsyncPager

Lists all the xref_Catalogs associated with the project.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.list_catalogs

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.list_operations

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_attributes_config_path

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

Parses a attributes_config path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_attributes_config_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_branch_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_completion_config_path

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

Parses a completion_config path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.parse_completion_config_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.remove_catalog_attribute

remove_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.RemoveCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.AttributesConfig

Removes the specified xref_CatalogAttribute from the xref_AttributesConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.remove_catalog_attribute

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.replace_catalog_attribute

replace_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.ReplaceCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.AttributesConfig

Replaces the specified xref_CatalogAttribute in the xref_AttributesConfig by updating the catalog attribute with the same xref_CatalogAttribute.key.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.replace_catalog_attribute

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.set_default_branch

set_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.SetDefaultBranchRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Set a specified branch id as default branch.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.set_default_branch

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.update_attributes_config

update_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.UpdateAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    attributes_config: typing.Optional[
        google.cloud.retail_v2.types.catalog.AttributesConfig
    ] = 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_v2.types.catalog.AttributesConfig

Updates the xref_AttributesConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.update_attributes_config

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.update_catalog

update_catalog(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.UpdateCatalogRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[google.cloud.retail_v2.types.catalog.Catalog] = 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_v2.types.catalog.Catalog

Updates the xref_Catalogs.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.update_catalog

google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.update_completion_config

update_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.UpdateCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    completion_config: typing.Optional[
        google.cloud.retail_v2.types.catalog.CompletionConfig
    ] = 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_v2.types.catalog.CompletionConfig

Updates the xref_CompletionConfigs.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceAsyncClient.update_completion_config

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient

CatalogServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.catalog_service.transports.base.CatalogServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.catalog_service.transports.base.CatalogServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the catalog service client.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.exit

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.add_catalog_attribute

add_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.AddCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.AttributesConfig

Adds the specified xref_CatalogAttribute to the xref_AttributesConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.add_catalog_attribute

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.attributes_config_path

attributes_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified attributes_config string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.attributes_config_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.branch_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.catalog_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_billing_account_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_folder_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_location_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_organization_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.common_project_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.completion_config_path

completion_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified completion_config string.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.completion_config_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.from_service_account_file

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.from_service_account_info

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.from_service_account_json

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_attributes_config

get_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.GetAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.AttributesConfig

Gets an xref_AttributesConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_attributes_config

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_completion_config

get_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.GetCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.CompletionConfig

Gets a xref_CompletionConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_completion_config

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_default_branch

get_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.GetDefaultBranchRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog_service.GetDefaultBranchResponse

Get which branch is currently default branch set by xref_CatalogService.SetDefaultBranch method under a specified parent catalog.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_default_branch

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.get_operation

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.list_catalogs

list_catalogs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.ListCatalogsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.services.catalog_service.pagers.ListCatalogsPager

Lists all the xref_Catalogs associated with the project.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.list_catalogs

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.list_operations

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_attributes_config_path

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

Parses a attributes_config path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_attributes_config_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_branch_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_catalog_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_billing_account_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_folder_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_location_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_organization_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_common_project_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_completion_config_path

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

Parses a completion_config path into its component segments.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.parse_completion_config_path

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.remove_catalog_attribute

remove_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.RemoveCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.AttributesConfig

Removes the specified xref_CatalogAttribute from the xref_AttributesConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.remove_catalog_attribute

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.replace_catalog_attribute

replace_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.ReplaceCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.AttributesConfig

Replaces the specified xref_CatalogAttribute in the xref_AttributesConfig by updating the catalog attribute with the same xref_CatalogAttribute.key.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.replace_catalog_attribute

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.set_default_branch

set_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.SetDefaultBranchRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Set a specified branch id as default branch.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.set_default_branch

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.update_attributes_config

update_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.UpdateAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    attributes_config: typing.Optional[
        google.cloud.retail_v2.types.catalog.AttributesConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.AttributesConfig

Updates the xref_AttributesConfig.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.update_attributes_config

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.update_catalog

update_catalog(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.UpdateCatalogRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[google.cloud.retail_v2.types.catalog.Catalog] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.Catalog

Updates the xref_Catalogs.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.update_catalog

google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.update_completion_config

update_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.catalog_service.UpdateCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    completion_config: typing.Optional[
        google.cloud.retail_v2.types.catalog.CompletionConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.catalog.CompletionConfig

Updates the xref_CompletionConfigs.

See more: google.cloud.retail_v2.services.catalog_service.CatalogServiceClient.update_completion_config

google.cloud.retail_v2.services.catalog_service.pagers.ListCatalogsAsyncPager

ListCatalogsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2.types.catalog_service.ListCatalogsResponse
        ],
    ],
    request: google.cloud.retail_v2.types.catalog_service.ListCatalogsRequest,
    response: google.cloud.retail_v2.types.catalog_service.ListCatalogsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2.services.catalog_service.pagers.ListCatalogsAsyncPager

google.cloud.retail_v2.services.catalog_service.pagers.ListCatalogsPager

ListCatalogsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2.types.catalog_service.ListCatalogsResponse
    ],
    request: google.cloud.retail_v2.types.catalog_service.ListCatalogsRequest,
    response: google.cloud.retail_v2.types.catalog_service.ListCatalogsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2.services.catalog_service.pagers.ListCatalogsPager

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient

CompletionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.completion_service.transports.base.CompletionServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.completion_service.transports.base.CompletionServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the completion service async client.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.catalog_path

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.complete_query

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

Completes the specified prefix with keyword suggestions.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.from_service_account_file

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

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

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.from_service_account_info

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

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

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.from_service_account_json

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

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

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.completion_service.transports.base.CompletionServiceTransport
    ]
)

Returns an appropriate transport class.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.import_completion_data

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

Bulk import of processed completion dataset.

See more: google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.import_completion_data

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient

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

Instantiates the completion service client.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.completion_service.CompletionServiceClient.catalog_path

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.common_location_path

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

Returns a fully-qualified location string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.complete_query

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

Completes the specified prefix with keyword suggestions.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.from_service_account_file

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

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

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.from_service_account_info

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

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

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.from_service_account_json

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

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

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.get_operation

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

Gets the latest state of a long-running operation.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.import_completion_data

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

Bulk import of processed completion dataset.

See more: google.cloud.retail_v2.services.completion_service.CompletionServiceClient.import_completion_data

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.completion_service.CompletionServiceClient.parse_catalog_path

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

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

google.cloud.retail_v2.services.completion_service.CompletionServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient

ControlServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.control_service.transports.base.ControlServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the control service async client.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.catalog_path

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.control_path

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

Returns a fully-qualified control string.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.create_control

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

Creates a Control.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.delete_control

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

Deletes a Control.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.from_service_account_file

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

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

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.from_service_account_info

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

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

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.from_service_account_json

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

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

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.get_control

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

Gets a Control.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.control_service.transports.base.ControlServiceTransport
    ]
)

Returns an appropriate transport class.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.list_controls

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

Lists all Controls by their parent xref_Catalog.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.parse_control_path

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

Parses a control path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceAsyncClient.update_control

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

Updates a Control.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient

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

Instantiates the control service client.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.control_service.ControlServiceClient.catalog_path

google.cloud.retail_v2.services.control_service.ControlServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.common_location_path

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

Returns a fully-qualified location string.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.control_path

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

Returns a fully-qualified control string.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.create_control

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

Creates a Control.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.delete_control

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

Deletes a Control.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.from_service_account_file

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

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

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.from_service_account_info

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

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

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.from_service_account_json

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

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

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.get_control

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

Gets a Control.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.get_operation

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

Gets the latest state of a long-running operation.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.list_controls

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

Lists all Controls by their parent xref_Catalog.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.control_service.ControlServiceClient.parse_catalog_path

google.cloud.retail_v2.services.control_service.ControlServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.parse_control_path

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

Parses a control path into its component segments.

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

google.cloud.retail_v2.services.control_service.ControlServiceClient.update_control

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

Updates a Control.

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

google.cloud.retail_v2.services.control_service.pagers.ListControlsAsyncPager

ListControlsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2.types.control_service.ListControlsResponse
        ],
    ],
    request: google.cloud.retail_v2.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2.types.control_service.ListControlsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

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

google.cloud.retail_v2.services.control_service.pagers.ListControlsPager

ListControlsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2.types.control_service.ListControlsResponse
    ],
    request: google.cloud.retail_v2.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2.types.control_service.ListControlsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

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

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient

ModelServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.model_service.transports.base.ModelServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.model_service.transports.base.ModelServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the model service async client.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.catalog_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_folder_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_location_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_organization_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.common_project_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.create_model

create_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.model_service.CreateModelRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    model: typing.Optional[google.cloud.retail_v2.types.model.Model] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.create_model

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.delete_model

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

Deletes an existing model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.delete_model

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.from_service_account_file

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.from_service_account_info

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.from_service_account_json

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.get_model

get_model(
    request: typing.Optional[
        typing.Union[google.cloud.retail_v2.types.model_service.GetModelRequest, 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_v2.types.model.Model

Gets a model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.get_model

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.get_operation

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.model_service.transports.base.ModelServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.get_transport_class

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.list_models

list_models(
    request: typing.Optional[
        typing.Union[google.cloud.retail_v2.types.model_service.ListModelsRequest, 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_v2.services.model_service.pagers.ListModelsAsyncPager

Lists all the models linked to this event store.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.list_models

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.list_operations

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.model_path

model_path(project: str, location: str, catalog: str, model: str) -> str

Returns a fully-qualified model string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.model_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_model_path

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

Parses a model path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.parse_model_path

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.pause_model

pause_model(
    request: typing.Optional[
        typing.Union[google.cloud.retail_v2.types.model_service.PauseModelRequest, 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_v2.types.model.Model

Pauses the training of an existing model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.pause_model

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.resume_model

resume_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.model_service.ResumeModelRequest, 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_v2.types.model.Model

Resumes the training of an existing model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.resume_model

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.tune_model

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

Tunes an existing model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.tune_model

google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.update_model

update_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.model_service.UpdateModelRequest, dict
        ]
    ] = None,
    *,
    model: typing.Optional[google.cloud.retail_v2.types.model.Model] = 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_v2.types.model.Model

Update of model metadata.

See more: google.cloud.retail_v2.services.model_service.ModelServiceAsyncClient.update_model

google.cloud.retail_v2.services.model_service.ModelServiceClient

ModelServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.model_service.transports.base.ModelServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.model_service.transports.base.ModelServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the model service client.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient

google.cloud.retail_v2.services.model_service.ModelServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.exit

google.cloud.retail_v2.services.model_service.ModelServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.catalog_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.common_billing_account_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.common_folder_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.common_location_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.common_organization_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.common_project_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.create_model

create_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.model_service.CreateModelRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    model: typing.Optional[google.cloud.retail_v2.types.model.Model] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.create_model

google.cloud.retail_v2.services.model_service.ModelServiceClient.delete_model

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

Deletes an existing model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.delete_model

google.cloud.retail_v2.services.model_service.ModelServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.from_service_account_file

google.cloud.retail_v2.services.model_service.ModelServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.from_service_account_info

google.cloud.retail_v2.services.model_service.ModelServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.from_service_account_json

google.cloud.retail_v2.services.model_service.ModelServiceClient.get_model

get_model(
    request: typing.Optional[
        typing.Union[google.cloud.retail_v2.types.model_service.GetModelRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.model.Model

Gets a model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.get_model

google.cloud.retail_v2.services.model_service.ModelServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.model_service.ModelServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.get_operation

google.cloud.retail_v2.services.model_service.ModelServiceClient.list_models

list_models(
    request: typing.Optional[
        typing.Union[google.cloud.retail_v2.types.model_service.ListModelsRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.services.model_service.pagers.ListModelsPager

Lists all the models linked to this event store.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.list_models

google.cloud.retail_v2.services.model_service.ModelServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.list_operations

google.cloud.retail_v2.services.model_service.ModelServiceClient.model_path

model_path(project: str, location: str, catalog: str, model: str) -> str

Returns a fully-qualified model string.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.model_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_catalog_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_billing_account_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_folder_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_location_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_organization_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_common_project_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_model_path

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

Parses a model path into its component segments.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.parse_model_path

google.cloud.retail_v2.services.model_service.ModelServiceClient.pause_model

pause_model(
    request: typing.Optional[
        typing.Union[google.cloud.retail_v2.types.model_service.PauseModelRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.model.Model

Pauses the training of an existing model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.pause_model

google.cloud.retail_v2.services.model_service.ModelServiceClient.resume_model

resume_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.model_service.ResumeModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.model.Model

Resumes the training of an existing model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.resume_model

google.cloud.retail_v2.services.model_service.ModelServiceClient.tune_model

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

Tunes an existing model.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.tune_model

google.cloud.retail_v2.services.model_service.ModelServiceClient.update_model

update_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.model_service.UpdateModelRequest, dict
        ]
    ] = None,
    *,
    model: typing.Optional[google.cloud.retail_v2.types.model.Model] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.model.Model

Update of model metadata.

See more: google.cloud.retail_v2.services.model_service.ModelServiceClient.update_model

google.cloud.retail_v2.services.model_service.pagers.ListModelsAsyncPager

ListModelsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.retail_v2.types.model_service.ListModelsResponse],
    ],
    request: google.cloud.retail_v2.types.model_service.ListModelsRequest,
    response: google.cloud.retail_v2.types.model_service.ListModelsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2.services.model_service.pagers.ListModelsAsyncPager

google.cloud.retail_v2.services.model_service.pagers.ListModelsPager

ListModelsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2.types.model_service.ListModelsResponse
    ],
    request: google.cloud.retail_v2.types.model_service.ListModelsRequest,
    response: google.cloud.retail_v2.types.model_service.ListModelsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2.services.model_service.pagers.ListModelsPager

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient

PredictionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.prediction_service.transports.base.PredictionServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.prediction_service.transports.base.PredictionServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the prediction service async client.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_folder_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_location_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_organization_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.common_project_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.get_operation

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.prediction_service.transports.base.PredictionServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.get_transport_class

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.list_operations

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.parse_product_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.predict

predict(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.prediction_service.PredictRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.prediction_service.PredictResponse

Makes a recommendation prediction.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.predict

google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceAsyncClient.product_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient

PredictionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.prediction_service.transports.base.PredictionServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.prediction_service.transports.base.PredictionServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the prediction service client.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.exit

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_billing_account_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_folder_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_location_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_organization_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.common_project_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.from_service_account_file

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.from_service_account_info

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.from_service_account_json

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.get_operation

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.list_operations

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_billing_account_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_folder_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_location_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_organization_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_common_project_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.parse_product_path

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.predict

predict(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.prediction_service.PredictRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.prediction_service.PredictResponse

Makes a recommendation prediction.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.predict

google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2.services.prediction_service.PredictionServiceClient.product_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient

ProductServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the product service async client.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.add_fulfillment_places

add_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.AddFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

We recommend that you use the xref_ProductService.AddLocalInventories method instead of the xref_ProductService.AddFulfillmentPlaces method.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.add_fulfillment_places

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.add_local_inventories

add_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.AddLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates local inventory information for a xref_Product at a list of places, while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.add_local_inventories

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.branch_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_folder_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_location_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_organization_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.common_project_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.create_product

create_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.CreateProductRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    product: typing.Optional[google.cloud.retail_v2.types.product.Product] = None,
    product_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.product.Product

Creates a xref_Product.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.create_product

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.delete_product

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

Deletes a xref_Product.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.delete_product

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.from_service_account_file

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.from_service_account_info

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.from_service_account_json

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.get_operation

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.get_product

get_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.GetProductRequest, 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_v2.types.product.Product

Gets a xref_Product.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.get_product

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.get_transport_class

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.import_products

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

Bulk import of multiple xref_Products.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.import_products

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.list_operations

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.list_products

list_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.ListProductsRequest, 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_v2.services.product_service.pagers.ListProductsAsyncPager

Gets a list of xref_Products.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.list_products

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_branch_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.parse_product_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.product_path

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.purge_products

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

Permanently deletes all selected xref_Products under a branch.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.purge_products

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.remove_fulfillment_places

remove_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.RemoveFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

We recommend that you use the xref_ProductService.RemoveLocalInventories method instead of the xref_ProductService.RemoveFulfillmentPlaces method.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.remove_fulfillment_places

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.remove_local_inventories

remove_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.RemoveLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Remove local inventory information for a xref_Product at a list of places at a removal timestamp.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.remove_local_inventories

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.set_inventory

set_inventory(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.SetInventoryRequest, dict
        ]
    ] = None,
    *,
    inventory: typing.Optional[google.cloud.retail_v2.types.product.Product] = None,
    set_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.api_core.operation_async.AsyncOperation

Updates inventory information for a xref_Product while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.set_inventory

google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.update_product

update_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.UpdateProductRequest, dict
        ]
    ] = None,
    *,
    product: typing.Optional[google.cloud.retail_v2.types.product.Product] = 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_v2.types.product.Product

Updates a xref_Product.

See more: google.cloud.retail_v2.services.product_service.ProductServiceAsyncClient.update_product

google.cloud.retail_v2.services.product_service.ProductServiceClient

ProductServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.product_service.transports.base.ProductServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the product service client.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient

google.cloud.retail_v2.services.product_service.ProductServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.exit

google.cloud.retail_v2.services.product_service.ProductServiceClient.add_fulfillment_places

add_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.AddFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

We recommend that you use the xref_ProductService.AddLocalInventories method instead of the xref_ProductService.AddFulfillmentPlaces method.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.add_fulfillment_places

google.cloud.retail_v2.services.product_service.ProductServiceClient.add_local_inventories

add_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.AddLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates local inventory information for a xref_Product at a list of places, while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.add_local_inventories

google.cloud.retail_v2.services.product_service.ProductServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.branch_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.common_billing_account_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.common_folder_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.common_location_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.common_organization_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.common_project_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.create_product

create_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.CreateProductRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    product: typing.Optional[google.cloud.retail_v2.types.product.Product] = None,
    product_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.product.Product

Creates a xref_Product.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.create_product

google.cloud.retail_v2.services.product_service.ProductServiceClient.delete_product

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

Deletes a xref_Product.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.delete_product

google.cloud.retail_v2.services.product_service.ProductServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.from_service_account_file

google.cloud.retail_v2.services.product_service.ProductServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.from_service_account_info

google.cloud.retail_v2.services.product_service.ProductServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.from_service_account_json

google.cloud.retail_v2.services.product_service.ProductServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.product_service.ProductServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.get_operation

google.cloud.retail_v2.services.product_service.ProductServiceClient.get_product

get_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.GetProductRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.product.Product

Gets a xref_Product.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.get_product

google.cloud.retail_v2.services.product_service.ProductServiceClient.import_products

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

Bulk import of multiple xref_Products.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.import_products

google.cloud.retail_v2.services.product_service.ProductServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.list_operations

google.cloud.retail_v2.services.product_service.ProductServiceClient.list_products

list_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.ListProductsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.services.product_service.pagers.ListProductsPager

Gets a list of xref_Products.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.list_products

google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_branch_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_billing_account_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_folder_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_location_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_organization_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_common_project_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.parse_product_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.product_path

google.cloud.retail_v2.services.product_service.ProductServiceClient.purge_products

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

Permanently deletes all selected xref_Products under a branch.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.purge_products

google.cloud.retail_v2.services.product_service.ProductServiceClient.remove_fulfillment_places

remove_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.RemoveFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

We recommend that you use the xref_ProductService.RemoveLocalInventories method instead of the xref_ProductService.RemoveFulfillmentPlaces method.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.remove_fulfillment_places

google.cloud.retail_v2.services.product_service.ProductServiceClient.remove_local_inventories

remove_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.RemoveLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Remove local inventory information for a xref_Product at a list of places at a removal timestamp.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.remove_local_inventories

google.cloud.retail_v2.services.product_service.ProductServiceClient.set_inventory

set_inventory(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.SetInventoryRequest, dict
        ]
    ] = None,
    *,
    inventory: typing.Optional[google.cloud.retail_v2.types.product.Product] = None,
    set_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates inventory information for a xref_Product while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.set_inventory

google.cloud.retail_v2.services.product_service.ProductServiceClient.update_product

update_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.product_service.UpdateProductRequest, dict
        ]
    ] = None,
    *,
    product: typing.Optional[google.cloud.retail_v2.types.product.Product] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.product.Product

Updates a xref_Product.

See more: google.cloud.retail_v2.services.product_service.ProductServiceClient.update_product

google.cloud.retail_v2.services.product_service.pagers.ListProductsAsyncPager

ListProductsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2.types.product_service.ListProductsResponse
        ],
    ],
    request: google.cloud.retail_v2.types.product_service.ListProductsRequest,
    response: google.cloud.retail_v2.types.product_service.ListProductsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2.services.product_service.pagers.ListProductsAsyncPager

google.cloud.retail_v2.services.product_service.pagers.ListProductsPager

ListProductsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2.types.product_service.ListProductsResponse
    ],
    request: google.cloud.retail_v2.types.product_service.ListProductsRequest,
    response: google.cloud.retail_v2.types.product_service.ListProductsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2.services.product_service.pagers.ListProductsPager

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient

SearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.search_service.transports.base.SearchServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the search service async client.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.branch_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_folder_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_location_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_organization_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.common_project_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.experiment_path

experiment_path(project: str, location: str, catalog: str, experiment: str) -> str

Returns a fully-qualified experiment string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.experiment_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.from_service_account_file

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.from_service_account_info

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.from_service_account_json

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.get_operation

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.search_service.transports.base.SearchServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.get_transport_class

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.list_operations

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_branch_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_experiment_path

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

Parses a experiment path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_experiment_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_product_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_serving_config_path

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

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.parse_serving_config_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.product_path

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.search

search(
    request: typing.Optional[
        typing.Union[google.cloud.retail_v2.types.search_service.SearchRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.services.search_service.pagers.SearchAsyncPager

Performs a search.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.search

google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceAsyncClient.serving_config_path

google.cloud.retail_v2.services.search_service.SearchServiceClient

SearchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.search_service.transports.base.SearchServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the search service client.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient

google.cloud.retail_v2.services.search_service.SearchServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.exit

google.cloud.retail_v2.services.search_service.SearchServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.branch_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.common_billing_account_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.common_folder_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.common_location_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.common_organization_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.common_project_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.experiment_path

experiment_path(project: str, location: str, catalog: str, experiment: str) -> str

Returns a fully-qualified experiment string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.experiment_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.from_service_account_file

google.cloud.retail_v2.services.search_service.SearchServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.from_service_account_info

google.cloud.retail_v2.services.search_service.SearchServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.from_service_account_json

google.cloud.retail_v2.services.search_service.SearchServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.search_service.SearchServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.get_operation

google.cloud.retail_v2.services.search_service.SearchServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.list_operations

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_branch_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_billing_account_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_folder_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_location_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_organization_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_common_project_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_experiment_path

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

Parses a experiment path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_experiment_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_product_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_serving_config_path

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

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.parse_serving_config_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.product_path

google.cloud.retail_v2.services.search_service.SearchServiceClient.search

search(
    request: typing.Optional[
        typing.Union[google.cloud.retail_v2.types.search_service.SearchRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.services.search_service.pagers.SearchPager

Performs a search.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.search

google.cloud.retail_v2.services.search_service.SearchServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2.services.search_service.SearchServiceClient.serving_config_path

google.cloud.retail_v2.services.search_service.pagers.SearchAsyncPager

SearchAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.retail_v2.types.search_service.SearchResponse],
    ],
    request: google.cloud.retail_v2.types.search_service.SearchRequest,
    response: google.cloud.retail_v2.types.search_service.SearchResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2.services.search_service.pagers.SearchAsyncPager

google.cloud.retail_v2.services.search_service.pagers.SearchPager

SearchPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2.types.search_service.SearchResponse
    ],
    request: google.cloud.retail_v2.types.search_service.SearchRequest,
    response: google.cloud.retail_v2.types.search_service.SearchResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2.services.search_service.pagers.SearchPager

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient

ServingConfigServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.serving_config_service.transports.base.ServingConfigServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the serving config service async client.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.add_control

add_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.AddControlRequest, dict
        ]
    ] = None,
    *,
    serving_config: 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_v2.types.serving_config.ServingConfig

Enables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.add_control

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.catalog_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.create_serving_config

create_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.CreateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    serving_config: typing.Optional[
        google.cloud.retail_v2.types.serving_config.ServingConfig
    ] = None,
    serving_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.serving_config.ServingConfig

Creates a ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.create_serving_config

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.delete_serving_config

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

Deletes a ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.delete_serving_config

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_file

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_info

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_json

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.get_operation

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.get_serving_config

get_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.GetServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.serving_config.ServingConfig

Gets a ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.get_serving_config

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.serving_config_service.transports.base.ServingConfigServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.list_operations

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.list_serving_configs

list_serving_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.ListServingConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2.services.serving_config_service.pagers.ListServingConfigsAsyncPager
)

Lists all ServingConfigs linked to this catalog.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.list_serving_configs

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_serving_config_path

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

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.parse_serving_config_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.remove_control

remove_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.RemoveControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: 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_v2.types.serving_config.ServingConfig

Disables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.remove_control

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.serving_config_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config

update_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.UpdateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[
        google.cloud.retail_v2.types.serving_config.ServingConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.serving_config.ServingConfig

Updates a ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient

ServingConfigServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.serving_config_service.transports.base.ServingConfigServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the serving config service client.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.exit

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.add_control

add_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.AddControlRequest, dict
        ]
    ] = None,
    *,
    serving_config: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.serving_config.ServingConfig

Enables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.add_control

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.catalog_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_folder_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_location_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_organization_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.common_project_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.create_serving_config

create_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.CreateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    serving_config: typing.Optional[
        google.cloud.retail_v2.types.serving_config.ServingConfig
    ] = None,
    serving_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.serving_config.ServingConfig

Creates a ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.create_serving_config

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.delete_serving_config

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

Deletes a ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.delete_serving_config

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.from_service_account_file

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.from_service_account_info

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.from_service_account_json

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.get_operation

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.get_serving_config

get_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.GetServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.serving_config.ServingConfig

Gets a ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.get_serving_config

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.list_operations

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.list_serving_configs

list_serving_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.ListServingConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2.services.serving_config_service.pagers.ListServingConfigsPager
)

Lists all ServingConfigs linked to this catalog.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.list_serving_configs

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_catalog_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_billing_account_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_folder_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_location_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_organization_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_common_project_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_serving_config_path

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

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.parse_serving_config_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.remove_control

remove_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.RemoveControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.serving_config.ServingConfig

Disables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.remove_control

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.serving_config_path

google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.update_serving_config

update_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.serving_config_service.UpdateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[
        google.cloud.retail_v2.types.serving_config.ServingConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.serving_config.ServingConfig

Updates a ServingConfig.

See more: google.cloud.retail_v2.services.serving_config_service.ServingConfigServiceClient.update_serving_config

google.cloud.retail_v2.services.serving_config_service.pagers.ListServingConfigsAsyncPager

ListServingConfigsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2.types.serving_config_service.ListServingConfigsResponse
        ],
    ],
    request: google.cloud.retail_v2.types.serving_config_service.ListServingConfigsRequest,
    response: google.cloud.retail_v2.types.serving_config_service.ListServingConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2.services.serving_config_service.pagers.ListServingConfigsAsyncPager

google.cloud.retail_v2.services.serving_config_service.pagers.ListServingConfigsPager

ListServingConfigsPager(
    method: typing.Callable[
        [...],
        google.cloud.retail_v2.types.serving_config_service.ListServingConfigsResponse,
    ],
    request: google.cloud.retail_v2.types.serving_config_service.ListServingConfigsRequest,
    response: google.cloud.retail_v2.types.serving_config_service.ListServingConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2.services.serving_config_service.pagers.ListServingConfigsPager

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient

UserEventServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.user_event_service.transports.base.UserEventServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the user event service async client.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.catalog_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.collect_user_event

collect_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.user_event_service.CollectUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody

Writes a single user event from the browser.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.collect_user_event

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_folder_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_location_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_organization_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.common_project_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.get_operation

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2.services.user_event_service.transports.base.UserEventServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.get_transport_class

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.import_user_events

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

Bulk import of User events.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.import_user_events

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.list_operations

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.parse_product_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.product_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.purge_user_events

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

Deletes permanently all user events specified by the filter provided.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.purge_user_events

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.rejoin_user_events

rejoin_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.user_event_service.RejoinUserEventsRequest,
            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

Starts a user-event rejoin operation with latest product catalog.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.rejoin_user_events

google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.write_user_event

write_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.user_event_service.WriteUserEventRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.user_event.UserEvent

Writes a single user event.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceAsyncClient.write_user_event

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient

UserEventServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.retail_v2.services.user_event_service.transports.base.UserEventServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the user event service client.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.exit

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.catalog_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.collect_user_event

collect_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.user_event_service.CollectUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody

Writes a single user event from the browser.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.collect_user_event

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_billing_account_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_folder_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_location_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_organization_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.common_project_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.from_service_account_file

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.from_service_account_info

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.from_service_account_json

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.get_operation

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.import_user_events

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

Bulk import of User events.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.import_user_events

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.list_operations

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_catalog_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_billing_account_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_folder_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_location_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_organization_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_common_project_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.parse_product_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.product_path

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.purge_user_events

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

Deletes permanently all user events specified by the filter provided.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.purge_user_events

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.rejoin_user_events

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

Starts a user-event rejoin operation with latest product catalog.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.rejoin_user_events

google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.write_user_event

write_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2.types.user_event_service.WriteUserEventRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2.types.user_event.UserEvent

Writes a single user event.

See more: google.cloud.retail_v2.services.user_event_service.UserEventServiceClient.write_user_event

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient

AnalyticsServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.analytics_service.transports.base.AnalyticsServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.analytics_service.transports.base.AnalyticsServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the analytics service async client.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.export_analytics_metrics

export_analytics_metrics(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.export_config.ExportAnalyticsMetricsRequest,
            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

Exports analytics metrics.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.export_analytics_metrics

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.get_transport_class

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

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient

AnalyticsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.analytics_service.transports.base.AnalyticsServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.analytics_service.transports.base.AnalyticsServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the analytics service client.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.exit

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_location_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.common_project_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.export_analytics_metrics

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

Exports analytics metrics.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.export_analytics_metrics

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.get_operation

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.list_operations

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.analytics_service.AnalyticsServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient

BranchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.branch_service.transports.base.BranchServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.branch_service.transports.base.BranchServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the branch service async client.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.branch_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.catalog_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.get_branch

get_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.branch_service.GetBranchRequest, 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.branch.Branch

Retrieves a xref_Branch.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.get_branch

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.get_transport_class

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

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.list_branches

list_branches(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.branch_service.ListBranchesRequest, 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.branch_service.ListBranchesResponse

Lists all xref_Branchs under the specified parent xref_Catalog.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.list_branches

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_branch_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.parse_product_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceAsyncClient.product_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient

BranchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.branch_service.transports.base.BranchServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.branch_service.transports.base.BranchServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the branch service client.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.exit

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.branch_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.catalog_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_location_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.common_project_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.get_branch

get_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.branch_service.GetBranchRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.branch.Branch

Retrieves a xref_Branch.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.get_branch

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.get_operation

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.list_branches

list_branches(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.branch_service.ListBranchesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.branch_service.ListBranchesResponse

Lists all xref_Branchs under the specified parent xref_Catalog.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.list_branches

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.list_operations

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_branch_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_catalog_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_product_path

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

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.parse_product_path

google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.branch_service.BranchServiceClient.product_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient

CatalogServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.catalog_service.transports.base.CatalogServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.catalog_service.transports.base.CatalogServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the catalog service async client.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.add_catalog_attribute

add_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.AddCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Adds the specified xref_CatalogAttribute to the xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.add_catalog_attribute

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.attributes_config_path

attributes_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified attributes_config string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.attributes_config_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.batch_remove_catalog_attributes

batch_remove_catalog_attributes(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.BatchRemoveCatalogAttributesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2alpha.types.catalog_service.BatchRemoveCatalogAttributesResponse
)

Removes all specified xref_CatalogAttributes from the xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.batch_remove_catalog_attributes

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.branch_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.catalog_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.completion_config_path

completion_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified completion_config string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.completion_config_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_attributes_config

get_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.GetAttributesConfigRequest,
            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.catalog.AttributesConfig

Gets an xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_attributes_config

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_completion_config

get_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.GetCompletionConfigRequest,
            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.catalog.CompletionConfig

Gets a xref_CompletionConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_completion_config

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_default_branch

get_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.GetDefaultBranchRequest,
            dict,
        ]
    ] = None,
    *,
    catalog: 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.catalog_service.GetDefaultBranchResponse

Get which branch is currently default branch set by xref_CatalogService.SetDefaultBranch method under a specified parent catalog.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_default_branch

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_transport_class

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

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.list_catalogs

list_catalogs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsRequest, 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.services.catalog_service.pagers.ListCatalogsAsyncPager

Lists all the xref_Catalogs associated with the project.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.list_catalogs

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_attributes_config_path

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

Parses a attributes_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_attributes_config_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_branch_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_completion_config_path

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

Parses a completion_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.parse_completion_config_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.remove_catalog_attribute

remove_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.RemoveCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Removes the specified xref_CatalogAttribute from the xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.remove_catalog_attribute

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.replace_catalog_attribute

replace_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.ReplaceCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Replaces the specified xref_CatalogAttribute in the xref_AttributesConfig by updating the catalog attribute with the same xref_CatalogAttribute.key.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.replace_catalog_attribute

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.set_default_branch

set_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.SetDefaultBranchRequest,
            dict,
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Set a specified branch id as default branch.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.set_default_branch

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.update_attributes_config

update_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.UpdateAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    attributes_config: typing.Optional[
        google.cloud.retail_v2alpha.types.catalog.AttributesConfig
    ] = 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.catalog.AttributesConfig

Updates the xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.update_attributes_config

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.update_catalog

update_catalog(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.UpdateCatalogRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[google.cloud.retail_v2alpha.types.catalog.Catalog] = 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.catalog.Catalog

Updates the xref_Catalogs.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.update_catalog

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.update_completion_config

update_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.UpdateCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    completion_config: typing.Optional[
        google.cloud.retail_v2alpha.types.catalog.CompletionConfig
    ] = 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.catalog.CompletionConfig

Updates the xref_CompletionConfigs.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceAsyncClient.update_completion_config

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient

CatalogServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.catalog_service.transports.base.CatalogServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.catalog_service.transports.base.CatalogServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the catalog service client.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.exit

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.add_catalog_attribute

add_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.AddCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Adds the specified xref_CatalogAttribute to the xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.add_catalog_attribute

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.attributes_config_path

attributes_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified attributes_config string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.attributes_config_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.batch_remove_catalog_attributes

batch_remove_catalog_attributes(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.BatchRemoveCatalogAttributesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2alpha.types.catalog_service.BatchRemoveCatalogAttributesResponse
)

Removes all specified xref_CatalogAttributes from the xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.batch_remove_catalog_attributes

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.branch_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.catalog_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_location_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.common_project_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.completion_config_path

completion_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified completion_config string.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.completion_config_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.from_service_account_json

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

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

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_attributes_config

get_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.GetAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Gets an xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_attributes_config

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_completion_config

get_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.GetCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.CompletionConfig

Gets a xref_CompletionConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_completion_config

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_default_branch

get_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.GetDefaultBranchRequest,
            dict,
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog_service.GetDefaultBranchResponse

Get which branch is currently default branch set by xref_CatalogService.SetDefaultBranch method under a specified parent catalog.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_default_branch

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.get_operation

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.list_catalogs

list_catalogs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsPager

Lists all the xref_Catalogs associated with the project.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.list_catalogs

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.list_operations

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_attributes_config_path

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

Parses a attributes_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_attributes_config_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_branch_path

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

Parses a branch path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_branch_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_catalog_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_completion_config_path

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

Parses a completion_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.parse_completion_config_path

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.remove_catalog_attribute

remove_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.RemoveCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Removes the specified xref_CatalogAttribute from the xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.remove_catalog_attribute

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.replace_catalog_attribute

replace_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.ReplaceCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Replaces the specified xref_CatalogAttribute in the xref_AttributesConfig by updating the catalog attribute with the same xref_CatalogAttribute.key.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.replace_catalog_attribute

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.set_default_branch

set_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.SetDefaultBranchRequest,
            dict,
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Set a specified branch id as default branch.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.set_default_branch

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.update_attributes_config

update_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.UpdateAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    attributes_config: typing.Optional[
        google.cloud.retail_v2alpha.types.catalog.AttributesConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Updates the xref_AttributesConfig.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.update_attributes_config

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.update_catalog

update_catalog(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.UpdateCatalogRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[google.cloud.retail_v2alpha.types.catalog.Catalog] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.Catalog

Updates the xref_Catalogs.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.update_catalog

google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.update_completion_config

update_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.catalog_service.UpdateCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    completion_config: typing.Optional[
        google.cloud.retail_v2alpha.types.catalog.CompletionConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.catalog.CompletionConfig

Updates the xref_CompletionConfigs.

See more: google.cloud.retail_v2alpha.services.catalog_service.CatalogServiceClient.update_completion_config

google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsAsyncPager

ListCatalogsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsResponse
        ],
    ],
    request: google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsRequest,
    response: google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsAsyncPager

google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsPager

ListCatalogsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsResponse
    ],
    request: google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsRequest,
    response: google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsPager

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient

CompletionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.completion_service.transports.base.CompletionServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.completion_service.transports.base.CompletionServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the completion service async client.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.catalog_path

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.complete_query

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

Completes the specified prefix with keyword suggestions.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.from_service_account_file

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

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

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.from_service_account_info

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

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

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.from_service_account_json

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

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

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.get_transport_class

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

Returns an appropriate transport class.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.import_completion_data

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

Bulk import of processed completion dataset.

See more: google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.import_completion_data

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient

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

Instantiates the completion service client.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.catalog_path

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.common_location_path

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

Returns a fully-qualified location string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.complete_query

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

Completes the specified prefix with keyword suggestions.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.from_service_account_file

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

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

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.from_service_account_info

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

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

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.from_service_account_json

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

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

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.get_operation

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

Gets the latest state of a long-running operation.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.import_completion_data

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

Bulk import of processed completion dataset.

See more: google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.import_completion_data

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.parse_catalog_path

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

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

google.cloud.retail_v2alpha.services.completion_service.CompletionServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient

ControlServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the control service async client.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.catalog_path

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.control_path

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

Returns a fully-qualified control string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.create_control

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

Creates a Control.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.delete_control

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

Deletes a Control.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.from_service_account_file

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

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

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.from_service_account_info

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

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

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.from_service_account_json

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

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

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.get_control

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

Gets a Control.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

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

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.get_transport_class

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

Returns an appropriate transport class.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.list_controls

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

Lists all Controls by their parent xref_Catalog.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.parse_control_path

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

Parses a control path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient.update_control

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

Updates a Control.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient

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

Instantiates the control service client.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.catalog_path

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.common_location_path

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

Returns a fully-qualified location string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.control_path

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

Returns a fully-qualified control string.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.create_control

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

Creates a Control.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.delete_control

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

Deletes a Control.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.from_service_account_file

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

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

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.from_service_account_info

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

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

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.from_service_account_json

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

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

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.get_control

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

Gets a Control.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.get_operation

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

Gets the latest state of a long-running operation.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.list_controls

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

Lists all Controls by their parent xref_Catalog.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.list_operations

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

Lists operations that match the specified filter in the request.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.parse_catalog_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.parse_catalog_path

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.parse_control_path

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

Parses a control path into its component segments.

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

google.cloud.retail_v2alpha.services.control_service.ControlServiceClient.update_control

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

Updates a Control.

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

google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsAsyncPager

ListControlsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2alpha.types.control_service.ListControlsResponse
        ],
    ],
    request: google.cloud.retail_v2alpha.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2alpha.types.control_service.ListControlsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

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

google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsPager

ListControlsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2alpha.types.control_service.ListControlsResponse
    ],
    request: google.cloud.retail_v2alpha.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2alpha.types.control_service.ListControlsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

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

MerchantCenterAccountLinkServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.merchant_center_account_link_service.transports.base.MerchantCenterAccountLinkServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.merchant_center_account_link_service.transports.base.MerchantCenterAccountLinkServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the merchant center account link service async client.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.catalog_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.common_billing_account_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.common_folder_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.common_location_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.common_organization_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.common_project_path

create_merchant_center_account_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.merchant_center_account_link_service.CreateMerchantCenterAccountLinkRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    merchant_center_account_link: typing.Optional[
        google.cloud.retail_v2alpha.types.merchant_center_account_link.MerchantCenterAccountLink
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a xref_MerchantCenterAccountLink.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.create_merchant_center_account_link

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

Deletes a xref_MerchantCenterAccountLink.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.delete_merchant_center_account_link

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

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

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.get_operation

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

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.get_transport_class

list_merchant_center_account_links(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.merchant_center_account_link_service.ListMerchantCenterAccountLinksRequest,
            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.merchant_center_account_link_service.ListMerchantCenterAccountLinksResponse
)

Lists all xref_MerchantCenterAccountLinks under the specified parent xref_Catalog.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.list_merchant_center_account_links

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.list_operations

merchant_center_account_link_path(
    project: str, location: str, catalog: str, merchant_center_account_link: str
) -> str

Returns a fully-qualified merchant_center_account_link string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.merchant_center_account_link_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.parse_catalog_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.parse_common_billing_account_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.parse_common_folder_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.parse_common_location_path

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

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.parse_common_organization_path

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

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.parse_common_project_path

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

Parses a merchant_center_account_link path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceAsyncClient.parse_merchant_center_account_link_path

MerchantCenterAccountLinkServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.merchant_center_account_link_service.transports.base.MerchantCenterAccountLinkServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.merchant_center_account_link_service.transports.base.MerchantCenterAccountLinkServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the merchant center account link service client.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient

google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.exit

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.catalog_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.common_billing_account_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.common_folder_path

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

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.common_location_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.common_organization_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.common_project_path

create_merchant_center_account_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.merchant_center_account_link_service.CreateMerchantCenterAccountLinkRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    merchant_center_account_link: typing.Optional[
        google.cloud.retail_v2alpha.types.merchant_center_account_link.MerchantCenterAccountLink
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a xref_MerchantCenterAccountLink.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.create_merchant_center_account_link

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

Deletes a xref_MerchantCenterAccountLink.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.delete_merchant_center_account_link

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

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

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.from_service_account_file

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

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

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.from_service_account_info

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

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

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.from_service_account_json

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

Deprecated.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.get_mtls_endpoint_and_cert_source

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

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.get_operation

list_merchant_center_account_links(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.merchant_center_account_link_service.ListMerchantCenterAccountLinksRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2alpha.types.merchant_center_account_link_service.ListMerchantCenterAccountLinksResponse
)

Lists all xref_MerchantCenterAccountLinks under the specified parent xref_Catalog.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.list_merchant_center_account_links

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

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.list_operations

merchant_center_account_link_path(
    project: str, location: str, catalog: str, merchant_center_account_link: str
) -> str

Returns a fully-qualified merchant_center_account_link string.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.merchant_center_account_link_path

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

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.parse_catalog_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.parse_common_billing_account_path

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

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.parse_common_folder_path

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

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.parse_common_location_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.parse_common_organization_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.parse_common_project_path

parse_merchant_center_account_link_path(path: str) -> typing.Dict[str, str]

Parses a merchant_center_account_link path into its component segments.

See more: google.cloud.retail_v2alpha.services.merchant_center_account_link_service.MerchantCenterAccountLinkServiceClient.parse_merchant_center_account_link_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient

ModelServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.model_service.transports.base.ModelServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.model_service.transports.base.ModelServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the model service async client.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.catalog_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.create_model

create_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.CreateModelRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    model: typing.Optional[google.cloud.retail_v2alpha.types.model.Model] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.create_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.delete_model

delete_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.DeleteModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an existing model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.delete_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.get_model

get_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.GetModelRequest, 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.model.Model

Gets a model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.get_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2alpha.services.model_service.transports.base.ModelServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.list_models

list_models(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.ListModelsRequest, 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.services.model_service.pagers.ListModelsAsyncPager

Lists all the models linked to this event store.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.list_models

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.model_path

model_path(project: str, location: str, catalog: str, model: str) -> str

Returns a fully-qualified model string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.model_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_model_path

parse_model_path(path: str) -> typing.Dict[str, str]

Parses a model path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.parse_model_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.pause_model

pause_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.PauseModelRequest, 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.model.Model

Pauses the training of an existing model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.pause_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.resume_model

resume_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.ResumeModelRequest, 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.model.Model

Resumes the training of an existing model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.resume_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.tune_model

tune_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.TuneModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Tunes an existing model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.tune_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.update_model

update_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.UpdateModelRequest, dict
        ]
    ] = None,
    *,
    model: typing.Optional[google.cloud.retail_v2alpha.types.model.Model] = 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.model.Model

Update of model metadata.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceAsyncClient.update_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient

ModelServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.model_service.transports.base.ModelServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.model_service.transports.base.ModelServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the model service client.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.exit

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.catalog_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_location_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.common_project_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.create_model

create_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.CreateModelRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    model: typing.Optional[google.cloud.retail_v2alpha.types.model.Model] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.create_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.delete_model

delete_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.DeleteModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an existing model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.delete_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.get_model

get_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.GetModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.model.Model

Gets a model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.get_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.get_operation

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.list_models

list_models(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.ListModelsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.services.model_service.pagers.ListModelsPager

Lists all the models linked to this event store.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.list_models

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.list_operations

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.model_path

model_path(project: str, location: str, catalog: str, model: str) -> str

Returns a fully-qualified model string.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.model_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_catalog_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_model_path

parse_model_path(path: str) -> typing.Dict[str, str]

Parses a model path into its component segments.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.parse_model_path

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.pause_model

pause_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.PauseModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.model.Model

Pauses the training of an existing model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.pause_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.resume_model

resume_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.ResumeModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.model.Model

Resumes the training of an existing model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.resume_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.tune_model

tune_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.TuneModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Tunes an existing model.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.tune_model

google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.update_model

update_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.model_service.UpdateModelRequest, dict
        ]
    ] = None,
    *,
    model: typing.Optional[google.cloud.retail_v2alpha.types.model.Model] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.model.Model

Update of model metadata.

See more: google.cloud.retail_v2alpha.services.model_service.ModelServiceClient.update_model

google.cloud.retail_v2alpha.services.model_service.pagers.ListModelsAsyncPager

ListModelsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2alpha.types.model_service.ListModelsResponse
        ],
    ],
    request: google.cloud.retail_v2alpha.types.model_service.ListModelsRequest,
    response: google.cloud.retail_v2alpha.types.model_service.ListModelsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2alpha.services.model_service.pagers.ListModelsAsyncPager

google.cloud.retail_v2alpha.services.model_service.pagers.ListModelsPager

ListModelsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2alpha.types.model_service.ListModelsResponse
    ],
    request: google.cloud.retail_v2alpha.types.model_service.ListModelsRequest,
    response: google.cloud.retail_v2alpha.types.model_service.ListModelsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2alpha.services.model_service.pagers.ListModelsPager

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient

PredictionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.prediction_service.transports.base.PredictionServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.prediction_service.transports.base.PredictionServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the prediction service async client.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2alpha.services.prediction_service.transports.base.PredictionServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.parse_product_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.predict

predict(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.prediction_service.PredictRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.prediction_service.PredictResponse

Makes a recommendation prediction.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.predict

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceAsyncClient.product_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient

PredictionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.prediction_service.transports.base.PredictionServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.prediction_service.transports.base.PredictionServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the prediction service client.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.exit

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_location_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.common_project_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.get_operation

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.list_operations

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.parse_product_path

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.predict

predict(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.prediction_service.PredictRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.prediction_service.PredictResponse

Makes a recommendation prediction.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.predict

google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.prediction_service.PredictionServiceClient.product_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient

ProductServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.product_service.transports.base.ProductServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.product_service.transports.base.ProductServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the product service async client.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.add_fulfillment_places

add_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.AddFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

We recommend that you use the xref_ProductService.AddLocalInventories method instead of the xref_ProductService.AddFulfillmentPlaces method.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.add_fulfillment_places

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.add_local_inventories

add_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.AddLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates local inventory information for a xref_Product at a list of places, while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.add_local_inventories

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.branch_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.create_product

create_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.CreateProductRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    product: typing.Optional[google.cloud.retail_v2alpha.types.product.Product] = None,
    product_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.product.Product

Creates a xref_Product.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.create_product

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.delete_product

delete_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.DeleteProductRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a xref_Product.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.delete_product

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.get_product

get_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.GetProductRequest, 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.product.Product

Gets a xref_Product.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.get_product

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2alpha.services.product_service.transports.base.ProductServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.import_products

import_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.import_config.ImportProductsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Bulk import of multiple xref_Products.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.import_products

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.list_products

list_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.ListProductsRequest, 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.services.product_service.pagers.ListProductsAsyncPager

Gets a list of xref_Products.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.list_products

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_branch_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.parse_product_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.product_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.purge_products

purge_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.purge_config.PurgeProductsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Permanently deletes all selected xref_Products under a branch.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.purge_products

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.remove_fulfillment_places

remove_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.RemoveFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

We recommend that you use the xref_ProductService.RemoveLocalInventories method instead of the xref_ProductService.RemoveFulfillmentPlaces method.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.remove_fulfillment_places

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.remove_local_inventories

remove_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.RemoveLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Remove local inventory information for a xref_Product at a list of places at a removal timestamp.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.remove_local_inventories

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.set_inventory

set_inventory(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.SetInventoryRequest, dict
        ]
    ] = None,
    *,
    inventory: typing.Optional[
        google.cloud.retail_v2alpha.types.product.Product
    ] = None,
    set_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.api_core.operation_async.AsyncOperation

Updates inventory information for a xref_Product while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.set_inventory

google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.update_product

update_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.UpdateProductRequest, dict
        ]
    ] = None,
    *,
    product: typing.Optional[google.cloud.retail_v2alpha.types.product.Product] = 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.product.Product

Updates a xref_Product.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceAsyncClient.update_product

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient

ProductServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.product_service.transports.base.ProductServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.product_service.transports.base.ProductServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the product service client.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.exit

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.add_fulfillment_places

add_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.AddFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

We recommend that you use the xref_ProductService.AddLocalInventories method instead of the xref_ProductService.AddFulfillmentPlaces method.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.add_fulfillment_places

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.add_local_inventories

add_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.AddLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates local inventory information for a xref_Product at a list of places, while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.add_local_inventories

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.branch_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_location_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.common_project_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.create_product

create_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.CreateProductRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    product: typing.Optional[google.cloud.retail_v2alpha.types.product.Product] = None,
    product_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.product.Product

Creates a xref_Product.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.create_product

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.delete_product

delete_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.DeleteProductRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a xref_Product.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.delete_product

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.get_operation

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.get_product

get_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.GetProductRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.product.Product

Gets a xref_Product.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.get_product

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.import_products

import_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.import_config.ImportProductsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Bulk import of multiple xref_Products.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.import_products

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.list_operations

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.list_products

list_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.ListProductsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.services.product_service.pagers.ListProductsPager

Gets a list of xref_Products.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.list_products

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_branch_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.parse_product_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.product_path

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.purge_products

purge_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.purge_config.PurgeProductsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Permanently deletes all selected xref_Products under a branch.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.purge_products

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.remove_fulfillment_places

remove_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.RemoveFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

We recommend that you use the xref_ProductService.RemoveLocalInventories method instead of the xref_ProductService.RemoveFulfillmentPlaces method.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.remove_fulfillment_places

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.remove_local_inventories

remove_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.RemoveLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Remove local inventory information for a xref_Product at a list of places at a removal timestamp.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.remove_local_inventories

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.set_inventory

set_inventory(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.SetInventoryRequest, dict
        ]
    ] = None,
    *,
    inventory: typing.Optional[
        google.cloud.retail_v2alpha.types.product.Product
    ] = None,
    set_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates inventory information for a xref_Product while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.set_inventory

google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.update_product

update_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.product_service.UpdateProductRequest, dict
        ]
    ] = None,
    *,
    product: typing.Optional[google.cloud.retail_v2alpha.types.product.Product] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.product.Product

Updates a xref_Product.

See more: google.cloud.retail_v2alpha.services.product_service.ProductServiceClient.update_product

google.cloud.retail_v2alpha.services.product_service.pagers.ListProductsAsyncPager

ListProductsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2alpha.types.product_service.ListProductsResponse
        ],
    ],
    request: google.cloud.retail_v2alpha.types.product_service.ListProductsRequest,
    response: google.cloud.retail_v2alpha.types.product_service.ListProductsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2alpha.services.product_service.pagers.ListProductsAsyncPager

google.cloud.retail_v2alpha.services.product_service.pagers.ListProductsPager

ListProductsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2alpha.types.product_service.ListProductsResponse
    ],
    request: google.cloud.retail_v2alpha.types.product_service.ListProductsRequest,
    response: google.cloud.retail_v2alpha.types.product_service.ListProductsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2alpha.services.product_service.pagers.ListProductsPager

google.cloud.retail_v2alpha.services.project_service.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 =

Instantiates the project service async client.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.accept_terms

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.alert_config_path

alert_config_path(project: str) -> str

Returns a fully-qualified alert_config string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.alert_config_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.enroll_solution

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_alert_config

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_logging_config

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_project

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2alpha.services.project_service.transports.base.ProjectServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.list_enrolled_solutions

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.logging_config_path

logging_config_path(project: str) -> str

Returns a fully-qualified logging_config string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.logging_config_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_alert_config_path

parse_alert_config_path(path: str) -> typing.Dict[str, str]

Parses a alert_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_alert_config_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_logging_config_path

parse_logging_config_path(path: str) -> typing.Dict[str, str]

Parses a logging_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_logging_config_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_retail_project_path

parse_retail_project_path(path: str) -> typing.Dict[str, str]

Parses a retail_project path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.parse_retail_project_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.retail_project_path

retail_project_path(project: str) -> str

Returns a fully-qualified retail_project string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.retail_project_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.update_alert_config

google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceAsyncClient.update_logging_config

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient

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 =

Instantiates the project service client.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.exit

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.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.Retry,
            google.api_core.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.accept_terms

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.alert_config_path

alert_config_path(project: str) -> str

Returns a fully-qualified alert_config string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.alert_config_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_location_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.common_project_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.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.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

The method enrolls a solution of type [Retail Search][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH] into a project.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.enroll_solution

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.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.Retry,
            google.api_core.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.get_alert_config

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.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.Retry,
            google.api_core.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.get_logging_config

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.get_operation

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.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.Retry,
            google.api_core.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.get_project

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.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.Retry,
            google.api_core.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.list_enrolled_solutions

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.list_operations

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.logging_config_path

logging_config_path(project: str) -> str

Returns a fully-qualified logging_config string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.logging_config_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_alert_config_path

parse_alert_config_path(path: str) -> typing.Dict[str, str]

Parses a alert_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_alert_config_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_logging_config_path

parse_logging_config_path(path: str) -> typing.Dict[str, str]

Parses a logging_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_logging_config_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_retail_project_path

parse_retail_project_path(path: str) -> typing.Dict[str, str]

Parses a retail_project path into its component segments.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.parse_retail_project_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.retail_project_path

retail_project_path(project: str) -> str

Returns a fully-qualified retail_project string.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.retail_project_path

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.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.Retry,
            google.api_core.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.update_alert_config

google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.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.Retry,
            google.api_core.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.

See more: google.cloud.retail_v2alpha.services.project_service.ProjectServiceClient.update_logging_config

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient

SearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.search_service.transports.base.SearchServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the search service async client.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.branch_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.experiment_path

experiment_path(project: str, location: str, catalog: str, experiment: str) -> str

Returns a fully-qualified experiment string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.experiment_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2alpha.services.search_service.transports.base.SearchServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_branch_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_experiment_path

parse_experiment_path(path: str) -> typing.Dict[str, str]

Parses a experiment path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_experiment_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_product_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.parse_serving_config_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.product_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.search

search(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.search_service.SearchRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.services.search_service.pagers.SearchAsyncPager

Performs a search.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.search

google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceAsyncClient.serving_config_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient

SearchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.search_service.transports.base.SearchServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the search service client.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.exit

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.branch_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_location_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.common_project_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.experiment_path

experiment_path(project: str, location: str, catalog: str, experiment: str) -> str

Returns a fully-qualified experiment string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.experiment_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.get_operation

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.list_operations

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_branch_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_experiment_path

parse_experiment_path(path: str) -> typing.Dict[str, str]

Parses a experiment path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_experiment_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_product_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.parse_serving_config_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.product_path

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.search

search(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.search_service.SearchRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.services.search_service.pagers.SearchPager

Performs a search.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.search

google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2alpha.services.search_service.SearchServiceClient.serving_config_path

google.cloud.retail_v2alpha.services.search_service.pagers.SearchAsyncPager

SearchAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2alpha.types.search_service.SearchResponse
        ],
    ],
    request: google.cloud.retail_v2alpha.types.search_service.SearchRequest,
    response: google.cloud.retail_v2alpha.types.search_service.SearchResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2alpha.services.search_service.pagers.SearchAsyncPager

google.cloud.retail_v2alpha.services.search_service.pagers.SearchPager

SearchPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2alpha.types.search_service.SearchResponse
    ],
    request: google.cloud.retail_v2alpha.types.search_service.SearchRequest,
    response: google.cloud.retail_v2alpha.types.search_service.SearchResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2alpha.services.search_service.pagers.SearchPager

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient

ServingConfigServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.serving_config_service.transports.base.ServingConfigServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the serving config service async client.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.add_control

add_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.AddControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: 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.serving_config.ServingConfig

Enables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.add_control

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.catalog_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.create_serving_config

create_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.CreateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    serving_config: typing.Optional[
        google.cloud.retail_v2alpha.types.serving_config.ServingConfig
    ] = None,
    serving_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.serving_config.ServingConfig

Creates a ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.create_serving_config

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.delete_serving_config

delete_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.DeleteServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.delete_serving_config

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_serving_config

get_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.GetServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.serving_config.ServingConfig

Gets a ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_serving_config

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2alpha.services.serving_config_service.transports.base.ServingConfigServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.list_serving_configs

list_serving_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2alpha.services.serving_config_service.pagers.ListServingConfigsAsyncPager
)

Lists all ServingConfigs linked to this catalog.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.list_serving_configs

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.parse_serving_config_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.remove_control

remove_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.RemoveControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: 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.serving_config.ServingConfig

Disables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.remove_control

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.serving_config_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config

update_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.UpdateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[
        google.cloud.retail_v2alpha.types.serving_config.ServingConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.serving_config.ServingConfig

Updates a ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient

ServingConfigServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.serving_config_service.transports.base.ServingConfigServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the serving config service client.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.exit

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.add_control

add_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.AddControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.serving_config.ServingConfig

Enables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.add_control

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.catalog_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_location_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.common_project_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.create_serving_config

create_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.CreateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    serving_config: typing.Optional[
        google.cloud.retail_v2alpha.types.serving_config.ServingConfig
    ] = None,
    serving_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.serving_config.ServingConfig

Creates a ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.create_serving_config

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.delete_serving_config

delete_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.DeleteServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.delete_serving_config

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.get_operation

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.get_serving_config

get_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.GetServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.serving_config.ServingConfig

Gets a ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.get_serving_config

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.list_operations

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.list_serving_configs

list_serving_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2alpha.services.serving_config_service.pagers.ListServingConfigsPager
)

Lists all ServingConfigs linked to this catalog.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.list_serving_configs

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_catalog_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.parse_serving_config_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.remove_control

remove_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.RemoveControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.serving_config.ServingConfig

Disables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.remove_control

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.serving_config_path

google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.update_serving_config

update_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.serving_config_service.UpdateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[
        google.cloud.retail_v2alpha.types.serving_config.ServingConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.serving_config.ServingConfig

Updates a ServingConfig.

See more: google.cloud.retail_v2alpha.services.serving_config_service.ServingConfigServiceClient.update_serving_config

google.cloud.retail_v2alpha.services.serving_config_service.pagers.ListServingConfigsAsyncPager

ListServingConfigsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsResponse
        ],
    ],
    request: google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsRequest,
    response: google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2alpha.services.serving_config_service.pagers.ListServingConfigsAsyncPager

google.cloud.retail_v2alpha.services.serving_config_service.pagers.ListServingConfigsPager

ListServingConfigsPager(
    method: typing.Callable[
        [...],
        google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsResponse,
    ],
    request: google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsRequest,
    response: google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2alpha.services.serving_config_service.pagers.ListServingConfigsPager

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient

UserEventServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.user_event_service.transports.base.UserEventServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the user event service async client.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.catalog_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.collect_user_event

collect_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.user_event_service.CollectUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody

Writes a single user event from the browser.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.collect_user_event

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_folder_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_location_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_organization_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.common_project_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.get_operation

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2alpha.services.user_event_service.transports.base.UserEventServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.get_transport_class

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.import_user_events

import_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.import_config.ImportUserEventsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Bulk import of User events.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.import_user_events

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.list_operations

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.parse_product_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.product_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.purge_user_events

purge_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.purge_config.PurgeUserEventsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes permanently all user events specified by the filter provided.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.purge_user_events

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.rejoin_user_events

rejoin_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.user_event_service.RejoinUserEventsRequest,
            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

Starts a user-event rejoin operation with latest product catalog.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.rejoin_user_events

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.write_user_event

write_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.user_event_service.WriteUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.user_event.UserEvent

Writes a single user event.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceAsyncClient.write_user_event

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient

UserEventServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.user_event_service.transports.base.UserEventServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the user event service client.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.exit

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.catalog_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.collect_user_event

collect_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.user_event_service.CollectUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody

Writes a single user event from the browser.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.collect_user_event

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_billing_account_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_folder_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_location_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_organization_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.common_project_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.from_service_account_file

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.from_service_account_info

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.from_service_account_json

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.get_operation

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.import_user_events

import_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.import_config.ImportUserEventsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Bulk import of User events.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.import_user_events

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.list_operations

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_catalog_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_billing_account_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_folder_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_location_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_organization_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_common_project_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.parse_product_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.product_path

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.purge_user_events

purge_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.purge_config.PurgeUserEventsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes permanently all user events specified by the filter provided.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.purge_user_events

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.rejoin_user_events

rejoin_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.user_event_service.RejoinUserEventsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Starts a user-event rejoin operation with latest product catalog.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.rejoin_user_events

google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.write_user_event

write_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2alpha.types.user_event_service.WriteUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2alpha.types.user_event.UserEvent

Writes a single user event.

See more: google.cloud.retail_v2alpha.services.user_event_service.UserEventServiceClient.write_user_event

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient

AnalyticsServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.analytics_service.transports.base.AnalyticsServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.analytics_service.transports.base.AnalyticsServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the analytics service async client.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.export_analytics_metrics

export_analytics_metrics(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.export_config.ExportAnalyticsMetricsRequest,
            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

Exports analytics metrics.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.export_analytics_metrics

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.analytics_service.transports.base.AnalyticsServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient

AnalyticsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.analytics_service.transports.base.AnalyticsServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.analytics_service.transports.base.AnalyticsServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the analytics service client.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.exit

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_folder_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_location_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_organization_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.common_project_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.export_analytics_metrics

export_analytics_metrics(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.export_config.ExportAnalyticsMetricsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Exports analytics metrics.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.export_analytics_metrics

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.get_operation

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.list_operations

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.analytics_service.AnalyticsServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient

CatalogServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.catalog_service.transports.base.CatalogServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.catalog_service.transports.base.CatalogServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the catalog service async client.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.add_catalog_attribute

add_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.AddCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.AttributesConfig

Adds the specified xref_CatalogAttribute to the xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.add_catalog_attribute

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.attributes_config_path

attributes_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified attributes_config string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.attributes_config_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.batch_remove_catalog_attributes

batch_remove_catalog_attributes(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.BatchRemoveCatalogAttributesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2beta.types.catalog_service.BatchRemoveCatalogAttributesResponse
)

Removes all specified xref_CatalogAttributes from the xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.batch_remove_catalog_attributes

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.branch_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.catalog_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.completion_config_path

completion_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified completion_config string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.completion_config_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_attributes_config

get_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.GetAttributesConfigRequest,
            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_v2beta.types.catalog.AttributesConfig

Gets an xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_attributes_config

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_completion_config

get_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.GetCompletionConfigRequest,
            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_v2beta.types.catalog.CompletionConfig

Gets a xref_CompletionConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_completion_config

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_default_branch

get_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.GetDefaultBranchRequest,
            dict,
        ]
    ] = None,
    *,
    catalog: 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_v2beta.types.catalog_service.GetDefaultBranchResponse

Get which branch is currently default branch set by xref_CatalogService.SetDefaultBranch method under a specified parent catalog.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_default_branch

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.catalog_service.transports.base.CatalogServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.list_catalogs

list_catalogs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.ListCatalogsRequest, 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_v2beta.services.catalog_service.pagers.ListCatalogsAsyncPager

Lists all the xref_Catalogs associated with the project.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.list_catalogs

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_attributes_config_path

parse_attributes_config_path(path: str) -> typing.Dict[str, str]

Parses a attributes_config path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_attributes_config_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_branch_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_completion_config_path

parse_completion_config_path(path: str) -> typing.Dict[str, str]

Parses a completion_config path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.parse_completion_config_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.remove_catalog_attribute

remove_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.RemoveCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.AttributesConfig

Removes the specified xref_CatalogAttribute from the xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.remove_catalog_attribute

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.replace_catalog_attribute

replace_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.ReplaceCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.AttributesConfig

Replaces the specified xref_CatalogAttribute in the xref_AttributesConfig by updating the catalog attribute with the same xref_CatalogAttribute.key.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.replace_catalog_attribute

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.set_default_branch

set_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.SetDefaultBranchRequest,
            dict,
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Set a specified branch id as default branch.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.set_default_branch

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.update_attributes_config

update_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.UpdateAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    attributes_config: typing.Optional[
        google.cloud.retail_v2beta.types.catalog.AttributesConfig
    ] = 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_v2beta.types.catalog.AttributesConfig

Updates the xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.update_attributes_config

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.update_catalog

update_catalog(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.UpdateCatalogRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[google.cloud.retail_v2beta.types.catalog.Catalog] = 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_v2beta.types.catalog.Catalog

Updates the xref_Catalogs.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.update_catalog

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.update_completion_config

update_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.UpdateCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    completion_config: typing.Optional[
        google.cloud.retail_v2beta.types.catalog.CompletionConfig
    ] = 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_v2beta.types.catalog.CompletionConfig

Updates the xref_CompletionConfigs.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceAsyncClient.update_completion_config

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient

CatalogServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.catalog_service.transports.base.CatalogServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.catalog_service.transports.base.CatalogServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the catalog service client.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.exit

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.add_catalog_attribute

add_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.AddCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.AttributesConfig

Adds the specified xref_CatalogAttribute to the xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.add_catalog_attribute

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.attributes_config_path

attributes_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified attributes_config string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.attributes_config_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.batch_remove_catalog_attributes

batch_remove_catalog_attributes(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.BatchRemoveCatalogAttributesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2beta.types.catalog_service.BatchRemoveCatalogAttributesResponse
)

Removes all specified xref_CatalogAttributes from the xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.batch_remove_catalog_attributes

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.branch_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.catalog_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_folder_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_location_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_organization_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.common_project_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.completion_config_path

completion_config_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified completion_config string.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.completion_config_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_attributes_config

get_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.GetAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.AttributesConfig

Gets an xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_attributes_config

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_completion_config

get_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.GetCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.CompletionConfig

Gets a xref_CompletionConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_completion_config

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_default_branch

get_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.GetDefaultBranchRequest,
            dict,
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog_service.GetDefaultBranchResponse

Get which branch is currently default branch set by xref_CatalogService.SetDefaultBranch method under a specified parent catalog.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_default_branch

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.get_operation

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.list_catalogs

list_catalogs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.ListCatalogsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.services.catalog_service.pagers.ListCatalogsPager

Lists all the xref_Catalogs associated with the project.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.list_catalogs

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.list_operations

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_attributes_config_path

parse_attributes_config_path(path: str) -> typing.Dict[str, str]

Parses a attributes_config path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_attributes_config_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_branch_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_catalog_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_completion_config_path

parse_completion_config_path(path: str) -> typing.Dict[str, str]

Parses a completion_config path into its component segments.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.parse_completion_config_path

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.remove_catalog_attribute

remove_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.RemoveCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.AttributesConfig

Removes the specified xref_CatalogAttribute from the xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.remove_catalog_attribute

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.replace_catalog_attribute

replace_catalog_attribute(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.ReplaceCatalogAttributeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.AttributesConfig

Replaces the specified xref_CatalogAttribute in the xref_AttributesConfig by updating the catalog attribute with the same xref_CatalogAttribute.key.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.replace_catalog_attribute

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.set_default_branch

set_default_branch(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.SetDefaultBranchRequest,
            dict,
        ]
    ] = None,
    *,
    catalog: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Set a specified branch id as default branch.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.set_default_branch

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.update_attributes_config

update_attributes_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.UpdateAttributesConfigRequest,
            dict,
        ]
    ] = None,
    *,
    attributes_config: typing.Optional[
        google.cloud.retail_v2beta.types.catalog.AttributesConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.AttributesConfig

Updates the xref_AttributesConfig.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.update_attributes_config

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.update_catalog

update_catalog(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.UpdateCatalogRequest, dict
        ]
    ] = None,
    *,
    catalog: typing.Optional[google.cloud.retail_v2beta.types.catalog.Catalog] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.Catalog

Updates the xref_Catalogs.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.update_catalog

google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.update_completion_config

update_completion_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.catalog_service.UpdateCompletionConfigRequest,
            dict,
        ]
    ] = None,
    *,
    completion_config: typing.Optional[
        google.cloud.retail_v2beta.types.catalog.CompletionConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.catalog.CompletionConfig

Updates the xref_CompletionConfigs.

See more: google.cloud.retail_v2beta.services.catalog_service.CatalogServiceClient.update_completion_config

google.cloud.retail_v2beta.services.catalog_service.pagers.ListCatalogsAsyncPager

ListCatalogsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2beta.types.catalog_service.ListCatalogsResponse
        ],
    ],
    request: google.cloud.retail_v2beta.types.catalog_service.ListCatalogsRequest,
    response: google.cloud.retail_v2beta.types.catalog_service.ListCatalogsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2beta.services.catalog_service.pagers.ListCatalogsAsyncPager

google.cloud.retail_v2beta.services.catalog_service.pagers.ListCatalogsPager

ListCatalogsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2beta.types.catalog_service.ListCatalogsResponse
    ],
    request: google.cloud.retail_v2beta.types.catalog_service.ListCatalogsRequest,
    response: google.cloud.retail_v2beta.types.catalog_service.ListCatalogsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2beta.services.catalog_service.pagers.ListCatalogsPager

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient

CompletionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.completion_service.transports.base.CompletionServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.completion_service.transports.base.CompletionServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the completion service async client.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.catalog_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.complete_query

complete_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.completion_service.CompleteQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.completion_service.CompleteQueryResponse

Completes the specified prefix with keyword suggestions.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.complete_query

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.completion_service.transports.base.CompletionServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.import_completion_data

import_completion_data(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.import_config.ImportCompletionDataRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Bulk import of processed completion dataset.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.import_completion_data

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient

CompletionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.completion_service.transports.base.CompletionServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.completion_service.transports.base.CompletionServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the completion service client.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.exit

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.catalog_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_folder_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_location_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_organization_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.common_project_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.complete_query

complete_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.completion_service.CompleteQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.completion_service.CompleteQueryResponse

Completes the specified prefix with keyword suggestions.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.complete_query

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.get_operation

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.import_completion_data

import_completion_data(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.import_config.ImportCompletionDataRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Bulk import of processed completion dataset.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.import_completion_data

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.list_operations

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_catalog_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.completion_service.CompletionServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient

ControlServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.control_service.transports.base.ControlServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the control service async client.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.catalog_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.control_path

control_path(project: str, location: str, catalog: str, control: str) -> str

Returns a fully-qualified control string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.control_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.create_control

create_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.CreateControlRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    control: typing.Optional[google.cloud.retail_v2beta.types.control.Control] = None,
    control_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.control.Control

Creates a Control.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.create_control

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.delete_control

delete_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.DeleteControlRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a Control.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.delete_control

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.get_control

get_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.GetControlRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.control.Control

Gets a Control.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.get_control

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.control_service.transports.base.ControlServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.list_controls

list_controls(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.ListControlsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.services.control_service.pagers.ListControlsAsyncPager

Lists all Controls by their parent xref_Catalog.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.list_controls

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_control_path

parse_control_path(path: str) -> typing.Dict[str, str]

Parses a control path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.parse_control_path

google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.update_control

update_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.UpdateControlRequest, dict
        ]
    ] = None,
    *,
    control: typing.Optional[google.cloud.retail_v2beta.types.control.Control] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.control.Control

Updates a Control.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceAsyncClient.update_control

google.cloud.retail_v2beta.services.control_service.ControlServiceClient

ControlServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.control_service.transports.base.ControlServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the control service client.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.exit

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.catalog_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_folder_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_location_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_organization_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.common_project_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.control_path

control_path(project: str, location: str, catalog: str, control: str) -> str

Returns a fully-qualified control string.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.control_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.create_control

create_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.CreateControlRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    control: typing.Optional[google.cloud.retail_v2beta.types.control.Control] = None,
    control_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.control.Control

Creates a Control.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.create_control

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.delete_control

delete_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.DeleteControlRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a Control.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.delete_control

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.get_control

get_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.GetControlRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.control.Control

Gets a Control.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.get_control

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.get_operation

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.list_controls

list_controls(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.ListControlsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.services.control_service.pagers.ListControlsPager

Lists all Controls by their parent xref_Catalog.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.list_controls

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.list_operations

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_catalog_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_control_path

parse_control_path(path: str) -> typing.Dict[str, str]

Parses a control path into its component segments.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.parse_control_path

google.cloud.retail_v2beta.services.control_service.ControlServiceClient.update_control

update_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.control_service.UpdateControlRequest, dict
        ]
    ] = None,
    *,
    control: typing.Optional[google.cloud.retail_v2beta.types.control.Control] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.control.Control

Updates a Control.

See more: google.cloud.retail_v2beta.services.control_service.ControlServiceClient.update_control

google.cloud.retail_v2beta.services.control_service.pagers.ListControlsAsyncPager

ListControlsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2beta.types.control_service.ListControlsResponse
        ],
    ],
    request: google.cloud.retail_v2beta.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2beta.types.control_service.ListControlsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2beta.services.control_service.pagers.ListControlsAsyncPager

google.cloud.retail_v2beta.services.control_service.pagers.ListControlsPager

ListControlsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2beta.types.control_service.ListControlsResponse
    ],
    request: google.cloud.retail_v2beta.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2beta.types.control_service.ListControlsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2beta.services.control_service.pagers.ListControlsPager

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient

ModelServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.model_service.transports.base.ModelServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.model_service.transports.base.ModelServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the model service async client.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.catalog_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.create_model

create_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.CreateModelRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    model: typing.Optional[google.cloud.retail_v2beta.types.model.Model] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.create_model

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.delete_model

delete_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.DeleteModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an existing model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.delete_model

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.get_model

get_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.GetModelRequest, 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_v2beta.types.model.Model

Gets a model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.get_model

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.model_service.transports.base.ModelServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.list_models

list_models(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.ListModelsRequest, 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_v2beta.services.model_service.pagers.ListModelsAsyncPager

Lists all the models linked to this event store.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.list_models

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.model_path

model_path(project: str, location: str, catalog: str, model: str) -> str

Returns a fully-qualified model string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.model_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_model_path

parse_model_path(path: str) -> typing.Dict[str, str]

Parses a model path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.parse_model_path

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.pause_model

pause_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.PauseModelRequest, 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_v2beta.types.model.Model

Pauses the training of an existing model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.pause_model

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.resume_model

resume_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.ResumeModelRequest, 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_v2beta.types.model.Model

Resumes the training of an existing model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.resume_model

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.tune_model

tune_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.TuneModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Tunes an existing model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.tune_model

google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.update_model

update_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.UpdateModelRequest, dict
        ]
    ] = None,
    *,
    model: typing.Optional[google.cloud.retail_v2beta.types.model.Model] = 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_v2beta.types.model.Model

Update of model metadata.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceAsyncClient.update_model

google.cloud.retail_v2beta.services.model_service.ModelServiceClient

ModelServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.model_service.transports.base.ModelServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.model_service.transports.base.ModelServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the model service client.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.exit

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.catalog_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_folder_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_location_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_organization_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.common_project_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.create_model

create_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.CreateModelRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    model: typing.Optional[google.cloud.retail_v2beta.types.model.Model] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.create_model

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.delete_model

delete_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.DeleteModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an existing model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.delete_model

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.get_model

get_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.GetModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.model.Model

Gets a model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.get_model

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.get_operation

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.list_models

list_models(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.ListModelsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.services.model_service.pagers.ListModelsPager

Lists all the models linked to this event store.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.list_models

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.list_operations

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.model_path

model_path(project: str, location: str, catalog: str, model: str) -> str

Returns a fully-qualified model string.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.model_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_catalog_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_model_path

parse_model_path(path: str) -> typing.Dict[str, str]

Parses a model path into its component segments.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.parse_model_path

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.pause_model

pause_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.PauseModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.model.Model

Pauses the training of an existing model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.pause_model

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.resume_model

resume_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.ResumeModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.model.Model

Resumes the training of an existing model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.resume_model

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.tune_model

tune_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.TuneModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Tunes an existing model.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.tune_model

google.cloud.retail_v2beta.services.model_service.ModelServiceClient.update_model

update_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.model_service.UpdateModelRequest, dict
        ]
    ] = None,
    *,
    model: typing.Optional[google.cloud.retail_v2beta.types.model.Model] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.model.Model

Update of model metadata.

See more: google.cloud.retail_v2beta.services.model_service.ModelServiceClient.update_model

google.cloud.retail_v2beta.services.model_service.pagers.ListModelsAsyncPager

ListModelsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2beta.types.model_service.ListModelsResponse
        ],
    ],
    request: google.cloud.retail_v2beta.types.model_service.ListModelsRequest,
    response: google.cloud.retail_v2beta.types.model_service.ListModelsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2beta.services.model_service.pagers.ListModelsAsyncPager

google.cloud.retail_v2beta.services.model_service.pagers.ListModelsPager

ListModelsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2beta.types.model_service.ListModelsResponse
    ],
    request: google.cloud.retail_v2beta.types.model_service.ListModelsRequest,
    response: google.cloud.retail_v2beta.types.model_service.ListModelsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2beta.services.model_service.pagers.ListModelsPager

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient

PredictionServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.prediction_service.transports.base.PredictionServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.prediction_service.transports.base.PredictionServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the prediction service async client.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.prediction_service.transports.base.PredictionServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.parse_product_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.predict

predict(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.prediction_service.PredictRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.prediction_service.PredictResponse

Makes a recommendation prediction.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.predict

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceAsyncClient.product_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient

PredictionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.prediction_service.transports.base.PredictionServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.prediction_service.transports.base.PredictionServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the prediction service client.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.exit

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_folder_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_location_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_organization_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.common_project_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.get_operation

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.list_operations

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.parse_product_path

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.predict

predict(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.prediction_service.PredictRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.prediction_service.PredictResponse

Makes a recommendation prediction.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.predict

google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2beta.services.prediction_service.PredictionServiceClient.product_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient

ProductServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.product_service.transports.base.ProductServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.product_service.transports.base.ProductServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the product service async client.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.add_fulfillment_places

add_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.AddFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

We recommend that you use the xref_ProductService.AddLocalInventories method instead of the xref_ProductService.AddFulfillmentPlaces method.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.add_fulfillment_places

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.add_local_inventories

add_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.AddLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates local inventory information for a xref_Product at a list of places, while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.add_local_inventories

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.branch_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.create_product

create_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.CreateProductRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    product: typing.Optional[google.cloud.retail_v2beta.types.product.Product] = None,
    product_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.product.Product

Creates a xref_Product.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.create_product

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.delete_product

delete_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.DeleteProductRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a xref_Product.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.delete_product

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.get_product

get_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.GetProductRequest, 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_v2beta.types.product.Product

Gets a xref_Product.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.get_product

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.product_service.transports.base.ProductServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.import_products

import_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.import_config.ImportProductsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Bulk import of multiple xref_Products.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.import_products

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.list_products

list_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.ListProductsRequest, 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_v2beta.services.product_service.pagers.ListProductsAsyncPager

Gets a list of xref_Products.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.list_products

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_branch_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.parse_product_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.product_path

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.purge_products

purge_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.purge_config.PurgeProductsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Permanently deletes all selected xref_Products under a branch.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.purge_products

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.remove_fulfillment_places

remove_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.RemoveFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

We recommend that you use the xref_ProductService.RemoveLocalInventories method instead of the xref_ProductService.RemoveFulfillmentPlaces method.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.remove_fulfillment_places

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.remove_local_inventories

remove_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.RemoveLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Remove local inventory information for a xref_Product at a list of places at a removal timestamp.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.remove_local_inventories

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.set_inventory

set_inventory(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.SetInventoryRequest, dict
        ]
    ] = None,
    *,
    inventory: typing.Optional[google.cloud.retail_v2beta.types.product.Product] = None,
    set_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.api_core.operation_async.AsyncOperation

Updates inventory information for a xref_Product while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.set_inventory

google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.update_product

update_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.UpdateProductRequest, dict
        ]
    ] = None,
    *,
    product: typing.Optional[google.cloud.retail_v2beta.types.product.Product] = 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_v2beta.types.product.Product

Updates a xref_Product.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceAsyncClient.update_product

google.cloud.retail_v2beta.services.product_service.ProductServiceClient

ProductServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.product_service.transports.base.ProductServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.product_service.transports.base.ProductServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the product service client.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.exit

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.add_fulfillment_places

add_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.AddFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

We recommend that you use the xref_ProductService.AddLocalInventories method instead of the xref_ProductService.AddFulfillmentPlaces method.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.add_fulfillment_places

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.add_local_inventories

add_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.AddLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates local inventory information for a xref_Product at a list of places, while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.add_local_inventories

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.branch_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_folder_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_location_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_organization_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.common_project_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.create_product

create_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.CreateProductRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    product: typing.Optional[google.cloud.retail_v2beta.types.product.Product] = None,
    product_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.product.Product

Creates a xref_Product.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.create_product

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.delete_product

delete_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.DeleteProductRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a xref_Product.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.delete_product

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.get_operation

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.get_product

get_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.GetProductRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.product.Product

Gets a xref_Product.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.get_product

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.import_products

import_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.import_config.ImportProductsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Bulk import of multiple xref_Products.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.import_products

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.list_operations

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.list_products

list_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.ListProductsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.services.product_service.pagers.ListProductsPager

Gets a list of xref_Products.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.list_products

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_branch_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.parse_product_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.product_path

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.purge_products

purge_products(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.purge_config.PurgeProductsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Permanently deletes all selected xref_Products under a branch.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.purge_products

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.remove_fulfillment_places

remove_fulfillment_places(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.RemoveFulfillmentPlacesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

We recommend that you use the xref_ProductService.RemoveLocalInventories method instead of the xref_ProductService.RemoveFulfillmentPlaces method.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.remove_fulfillment_places

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.remove_local_inventories

remove_local_inventories(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.RemoveLocalInventoriesRequest,
            dict,
        ]
    ] = None,
    *,
    product: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Remove local inventory information for a xref_Product at a list of places at a removal timestamp.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.remove_local_inventories

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.set_inventory

set_inventory(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.SetInventoryRequest, dict
        ]
    ] = None,
    *,
    inventory: typing.Optional[google.cloud.retail_v2beta.types.product.Product] = None,
    set_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates inventory information for a xref_Product while respecting the last update timestamps of each inventory field.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.set_inventory

google.cloud.retail_v2beta.services.product_service.ProductServiceClient.update_product

update_product(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.product_service.UpdateProductRequest, dict
        ]
    ] = None,
    *,
    product: typing.Optional[google.cloud.retail_v2beta.types.product.Product] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.product.Product

Updates a xref_Product.

See more: google.cloud.retail_v2beta.services.product_service.ProductServiceClient.update_product

google.cloud.retail_v2beta.services.product_service.pagers.ListProductsAsyncPager

ListProductsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2beta.types.product_service.ListProductsResponse
        ],
    ],
    request: google.cloud.retail_v2beta.types.product_service.ListProductsRequest,
    response: google.cloud.retail_v2beta.types.product_service.ListProductsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2beta.services.product_service.pagers.ListProductsAsyncPager

google.cloud.retail_v2beta.services.product_service.pagers.ListProductsPager

ListProductsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2beta.types.product_service.ListProductsResponse
    ],
    request: google.cloud.retail_v2beta.types.product_service.ListProductsRequest,
    response: google.cloud.retail_v2beta.types.product_service.ListProductsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2beta.services.product_service.pagers.ListProductsPager

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient

SearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.search_service.transports.base.SearchServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the search service async client.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.branch_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.experiment_path

experiment_path(project: str, location: str, catalog: str, experiment: str) -> str

Returns a fully-qualified experiment string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.experiment_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.search_service.transports.base.SearchServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_branch_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_experiment_path

parse_experiment_path(path: str) -> typing.Dict[str, str]

Parses a experiment path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_experiment_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_product_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.parse_serving_config_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.product_path

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.search

search(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.search_service.SearchRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.services.search_service.pagers.SearchAsyncPager

Performs a search.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.search

google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceAsyncClient.serving_config_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient

SearchServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.search_service.transports.base.SearchServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.search_service.transports.base.SearchServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the search service client.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.exit

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.branch_path

branch_path(project: str, location: str, catalog: str, branch: str) -> str

Returns a fully-qualified branch string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.branch_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_folder_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_location_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_organization_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.common_project_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.experiment_path

experiment_path(project: str, location: str, catalog: str, experiment: str) -> str

Returns a fully-qualified experiment string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.experiment_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.get_operation

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.list_operations

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_branch_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_experiment_path

parse_experiment_path(path: str) -> typing.Dict[str, str]

Parses a experiment path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_experiment_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_product_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.parse_serving_config_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.product_path

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.search

search(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.search_service.SearchRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.services.search_service.pagers.SearchPager

Performs a search.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.search

google.cloud.retail_v2beta.services.search_service.SearchServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2beta.services.search_service.SearchServiceClient.serving_config_path

google.cloud.retail_v2beta.services.search_service.pagers.SearchAsyncPager

SearchAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2beta.types.search_service.SearchResponse
        ],
    ],
    request: google.cloud.retail_v2beta.types.search_service.SearchRequest,
    response: google.cloud.retail_v2beta.types.search_service.SearchResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2beta.services.search_service.pagers.SearchAsyncPager

google.cloud.retail_v2beta.services.search_service.pagers.SearchPager

SearchPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2beta.types.search_service.SearchResponse
    ],
    request: google.cloud.retail_v2beta.types.search_service.SearchRequest,
    response: google.cloud.retail_v2beta.types.search_service.SearchResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2beta.services.search_service.pagers.SearchPager

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient

ServingConfigServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.serving_config_service.transports.base.ServingConfigServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the serving config service async client.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.add_control

add_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.AddControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: 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_v2beta.types.serving_config.ServingConfig

Enables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.add_control

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.catalog_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.create_serving_config

create_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.CreateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    serving_config: typing.Optional[
        google.cloud.retail_v2beta.types.serving_config.ServingConfig
    ] = None,
    serving_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.serving_config.ServingConfig

Creates a ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.create_serving_config

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.delete_serving_config

delete_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.DeleteServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.delete_serving_config

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_serving_config

get_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.GetServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.serving_config.ServingConfig

Gets a ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_serving_config

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.serving_config_service.transports.base.ServingConfigServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.list_serving_configs

list_serving_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.ListServingConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2beta.services.serving_config_service.pagers.ListServingConfigsAsyncPager
)

Lists all ServingConfigs linked to this catalog.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.list_serving_configs

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.parse_serving_config_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.remove_control

remove_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.RemoveControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: 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_v2beta.types.serving_config.ServingConfig

Disables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.remove_control

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.serving_config_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config

update_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.UpdateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[
        google.cloud.retail_v2beta.types.serving_config.ServingConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.serving_config.ServingConfig

Updates a ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceAsyncClient.update_serving_config

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient

ServingConfigServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.serving_config_service.transports.base.ServingConfigServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.serving_config_service.transports.base.ServingConfigServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the serving config service client.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.exit

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.add_control

add_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.AddControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.serving_config.ServingConfig

Enables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.add_control

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.catalog_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_folder_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_location_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_organization_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.common_project_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.create_serving_config

create_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.CreateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    serving_config: typing.Optional[
        google.cloud.retail_v2beta.types.serving_config.ServingConfig
    ] = None,
    serving_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.serving_config.ServingConfig

Creates a ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.create_serving_config

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.delete_serving_config

delete_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.DeleteServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.delete_serving_config

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.get_operation

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.get_serving_config

get_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.GetServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.serving_config.ServingConfig

Gets a ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.get_serving_config

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.list_operations

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.list_serving_configs

list_serving_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.ListServingConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.retail_v2beta.services.serving_config_service.pagers.ListServingConfigsPager
)

Lists all ServingConfigs linked to this catalog.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.list_serving_configs

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_catalog_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.parse_serving_config_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.remove_control

remove_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.RemoveControlRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.serving_config.ServingConfig

Disables a Control on the specified ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.remove_control

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.serving_config_path

serving_config_path(
    project: str, location: str, catalog: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.serving_config_path

google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.update_serving_config

update_serving_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.serving_config_service.UpdateServingConfigRequest,
            dict,
        ]
    ] = None,
    *,
    serving_config: typing.Optional[
        google.cloud.retail_v2beta.types.serving_config.ServingConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.serving_config.ServingConfig

Updates a ServingConfig.

See more: google.cloud.retail_v2beta.services.serving_config_service.ServingConfigServiceClient.update_serving_config

google.cloud.retail_v2beta.services.serving_config_service.pagers.ListServingConfigsAsyncPager

ListServingConfigsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2beta.types.serving_config_service.ListServingConfigsResponse
        ],
    ],
    request: google.cloud.retail_v2beta.types.serving_config_service.ListServingConfigsRequest,
    response: google.cloud.retail_v2beta.types.serving_config_service.ListServingConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.retail_v2beta.services.serving_config_service.pagers.ListServingConfigsAsyncPager

google.cloud.retail_v2beta.services.serving_config_service.pagers.ListServingConfigsPager

ListServingConfigsPager(
    method: typing.Callable[
        [...],
        google.cloud.retail_v2beta.types.serving_config_service.ListServingConfigsResponse,
    ],
    request: google.cloud.retail_v2beta.types.serving_config_service.ListServingConfigsRequest,
    response: google.cloud.retail_v2beta.types.serving_config_service.ListServingConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.retail_v2beta.services.serving_config_service.pagers.ListServingConfigsPager

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient

UserEventServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.user_event_service.transports.base.UserEventServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the user event service async client.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.catalog_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.collect_user_event

collect_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.user_event_service.CollectUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody

Writes a single user event from the browser.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.collect_user_event

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_folder_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_location_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_organization_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.common_project_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.get_operation

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.retail_v2beta.services.user_event_service.transports.base.UserEventServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.get_transport_class

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.import_user_events

import_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.import_config.ImportUserEventsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Bulk import of User events.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.import_user_events

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.list_operations

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_catalog_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.parse_product_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.product_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.purge_user_events

purge_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.purge_config.PurgeUserEventsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes permanently all user events specified by the filter provided.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.purge_user_events

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.rejoin_user_events

rejoin_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.user_event_service.RejoinUserEventsRequest,
            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

Starts a user-event rejoin operation with latest product catalog.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.rejoin_user_events

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.write_user_event

write_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.user_event_service.WriteUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.user_event.UserEvent

Writes a single user event.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceAsyncClient.write_user_event

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient

UserEventServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2beta.services.user_event_service.transports.base.UserEventServiceTransport, typing.Callable[[...], google.cloud.retail_v2beta.services.user_event_service.transports.base.UserEventServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the user event service client.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.exit

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.catalog_path

catalog_path(project: str, location: str, catalog: str) -> str

Returns a fully-qualified catalog string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.catalog_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.collect_user_event

collect_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.user_event_service.CollectUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api.httpbody_pb2.HttpBody

Writes a single user event from the browser.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.collect_user_event

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_billing_account_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_folder_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_location_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_organization_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.common_project_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.from_service_account_file

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.from_service_account_info

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.from_service_account_json

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.get_operation

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.import_user_events

import_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.import_config.ImportUserEventsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Bulk import of User events.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.import_user_events

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.list_operations

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_catalog_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_billing_account_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_folder_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_location_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_organization_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_common_project_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Parses a product path into its component segments.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.parse_product_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.product_path

product_path(
    project: str, location: str, catalog: str, branch: str, product: str
) -> str

Returns a fully-qualified product string.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.product_path

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.purge_user_events

purge_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.purge_config.PurgeUserEventsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes permanently all user events specified by the filter provided.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.purge_user_events

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.rejoin_user_events

rejoin_user_events(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.user_event_service.RejoinUserEventsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Starts a user-event rejoin operation with latest product catalog.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.rejoin_user_events

google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.write_user_event

write_user_event(
    request: typing.Optional[
        typing.Union[
            google.cloud.retail_v2beta.types.user_event_service.WriteUserEventRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.retail_v2beta.types.user_event.UserEvent

Writes a single user event.

See more: google.cloud.retail_v2beta.services.user_event_service.UserEventServiceClient.write_user_event