Class Branch (1.23.1)

Branch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A data branch that stores all instances of Products.

Attributes

Name Description
name str
Immutable. Full resource name of the branch, such as projects/*/locations/global/catalogs/default_catalog/branches/branch_id.
display_name str
Output only. Human readable name of the branch to display in the UI.
is_default bool
Output only. Indicates whether this branch is set as the default branch of its parent catalog.
last_product_import_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.
product_count_stats MutableSequence[google.cloud.retail_v2alpha.types.Branch.ProductCountStatistic]
Output only. Statistics for number of products in the branch, provided for different scopes. This field is not populated in [BranchView.BASIC][] view.
quality_metrics MutableSequence[google.cloud.retail_v2alpha.types.Branch.QualityMetric]
Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in [BranchView.BASIC][] view.

Classes

ProductCountStatistic

ProductCountStatistic(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A statistic about the number of products in a branch.

QualityMetric

QualityMetric(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Metric measured on a group of Products against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't.