Interface BranchOrBuilder (2.53.0)

Version 2.53.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public interface BranchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisplayName()

public abstract String getDisplayName()

Output only. Human readable name of the branch to display in the UI.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Output only. Human readable name of the branch to display in the UI.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for displayName.

getIsDefault()

public abstract boolean getIsDefault()

Output only. Indicates whether this branch is set as the default branch of its parent catalog.

bool is_default = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The isDefault.

getLastProductImportTime()

public abstract Timestamp getLastProductImportTime()

Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.

.google.protobuf.Timestamp last_product_import_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The lastProductImportTime.

getLastProductImportTimeOrBuilder()

public abstract TimestampOrBuilder getLastProductImportTimeOrBuilder()

Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.

.google.protobuf.Timestamp last_product_import_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getName()

public abstract String getName()

Immutable. Full resource name of the branch, such as projects/*/locations/global/catalogs/default_catalog/branches/branch_id.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. Full resource name of the branch, such as projects/*/locations/global/catalogs/default_catalog/branches/branch_id.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getProductCountStats(int index)

public abstract Branch.ProductCountStatistic getProductCountStats(int index)

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Branch.ProductCountStatistic

getProductCountStatsCount()

public abstract int getProductCountStatsCount()

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getProductCountStatsList()

public abstract List<Branch.ProductCountStatistic> getProductCountStatsList()

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<ProductCountStatistic>

getProductCountStatsOrBuilder(int index)

public abstract Branch.ProductCountStatisticOrBuilder getProductCountStatsOrBuilder(int index)

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Branch.ProductCountStatisticOrBuilder

getProductCountStatsOrBuilderList()

public abstract List<? extends Branch.ProductCountStatisticOrBuilder> getProductCountStatsOrBuilderList()

Output only. Statistics for number of products in the branch, provided for different scopes.

This field is not populated in [BranchView.BASIC][] view.

repeated .google.cloud.retail.v2alpha.Branch.ProductCountStatistic product_count_stats = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.retail.v2alpha.Branch.ProductCountStatisticOrBuilder>

getQualityMetrics(int index)

public abstract Branch.QualityMetric getQualityMetrics(int index)

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.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Branch.QualityMetric

getQualityMetricsCount()

public abstract int getQualityMetricsCount()

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.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getQualityMetricsList()

public abstract List<Branch.QualityMetric> getQualityMetricsList()

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.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<QualityMetric>

getQualityMetricsOrBuilder(int index)

public abstract Branch.QualityMetricOrBuilder getQualityMetricsOrBuilder(int index)

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.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Branch.QualityMetricOrBuilder

getQualityMetricsOrBuilderList()

public abstract List<? extends Branch.QualityMetricOrBuilder> getQualityMetricsOrBuilderList()

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.

repeated .google.cloud.retail.v2alpha.Branch.QualityMetric quality_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.retail.v2alpha.Branch.QualityMetricOrBuilder>

hasLastProductImportTime()

public abstract boolean hasLastProductImportTime()

Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.

.google.protobuf.Timestamp last_product_import_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the lastProductImportTime field is set.