com.google.cloud.retail.v2alpha

Interface BranchOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Branch, Branch.Builder

public interface BranchOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Output only.
com.google.protobuf.ByteString	getDisplayNameBytes() Output only.
boolean	getIsDefault() Output only.
com.google.protobuf.Timestamp	getLastProductImportTime() Output only.
com.google.protobuf.TimestampOrBuilder	getLastProductImportTimeOrBuilder() Output only.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
Branch.ProductCountStatistic	getProductCountStats(int index) Output only.
int	getProductCountStatsCount() Output only.
List<Branch.ProductCountStatistic>	getProductCountStatsList() Output only.
Branch.ProductCountStatisticOrBuilder	getProductCountStatsOrBuilder(int index) Output only.
List<? extends Branch.ProductCountStatisticOrBuilder>	getProductCountStatsOrBuilderList() Output only.
Branch.QualityMetric	getQualityMetrics(int index) Output only.
int	getQualityMetricsCount() Output only.
List<Branch.QualityMetric>	getQualityMetricsList() Output only.
Branch.QualityMetricOrBuilder	getQualityMetricsOrBuilder(int index) Output only.
List<? extends Branch.QualityMetricOrBuilder>	getQualityMetricsOrBuilderList() Output only.
boolean	hasLastProductImportTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

getIsDefault

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:

The isDefault.

hasLastProductImportTime

boolean hasLastProductImportTime()

 Output only. Timestamp of last import through
 [ProductService.ImportProducts][google.cloud.retail.v2alpha.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:

Whether the lastProductImportTime field is set.

getLastProductImportTime

com.google.protobuf.Timestamp getLastProductImportTime()

 Output only. Timestamp of last import through
 [ProductService.ImportProducts][google.cloud.retail.v2alpha.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:

The lastProductImportTime.

getLastProductImportTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getLastProductImportTimeOrBuilder()

 Output only. Timestamp of last import through
 [ProductService.ImportProducts][google.cloud.retail.v2alpha.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];

getProductCountStatsList

List<Branch.ProductCountStatistic> getProductCountStatsList()

 Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];

getProductCountStats

Branch.ProductCountStatistic getProductCountStats(int index)

 Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];

getProductCountStatsCount

int getProductCountStatsCount()

 Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];

getProductCountStatsOrBuilderList

List<? extends Branch.ProductCountStatisticOrBuilder> getProductCountStatsOrBuilderList()

 Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];

getProductCountStatsOrBuilder

Branch.ProductCountStatisticOrBuilder getProductCountStatsOrBuilder(int index)

 Output only. Statistics for number of products in the branch, provided for
 different
 [scopes][google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope].

 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];

getQualityMetricsList

List<Branch.QualityMetric> getQualityMetricsList()

 Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];

getQualityMetrics

Branch.QualityMetric getQualityMetrics(int index)

 Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];

getQualityMetricsCount

int getQualityMetricsCount()

 Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];

getQualityMetricsOrBuilderList

List<? extends Branch.QualityMetricOrBuilder> getQualityMetricsOrBuilderList()

 Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];

getQualityMetricsOrBuilder

Branch.QualityMetricOrBuilder getQualityMetricsOrBuilder(int index)

 Output only. The quality metrics measured among products of this branch.

 See
 [QualityMetric.requirement_key][google.cloud.retail.v2alpha.Branch.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];