Class Branch.Builder (2.53.0) 

public static final class Branch.Builder extends GeneratedMessageV3.Builder<Branch.Builder> implements BranchOrBuilder

A data branch that stores Products.

Protobuf type google.cloud.retail.v2alpha.Branch

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Branch.Builder

Implements

BranchOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllProductCountStats(Iterable<? extends Branch.ProductCountStatistic> values)

public Branch.Builder addAllProductCountStats(Iterable<? extends Branch.ProductCountStatistic> values)

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
values Iterable<? extends com.google.cloud.retail.v2alpha.Branch.ProductCountStatistic>
Returns
Type Description
Branch.Builder

addAllQualityMetrics(Iterable<? extends Branch.QualityMetric> values)

public Branch.Builder addAllQualityMetrics(Iterable<? extends Branch.QualityMetric> values)

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
values Iterable<? extends com.google.cloud.retail.v2alpha.Branch.QualityMetric>
Returns
Type Description
Branch.Builder

addProductCountStats(Branch.ProductCountStatistic value)

public Branch.Builder addProductCountStats(Branch.ProductCountStatistic value)

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
value Branch.ProductCountStatistic
Returns
Type Description
Branch.Builder

addProductCountStats(Branch.ProductCountStatistic.Builder builderForValue)

public Branch.Builder addProductCountStats(Branch.ProductCountStatistic.Builder builderForValue)

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
builderForValue Branch.ProductCountStatistic.Builder
Returns
Type Description
Branch.Builder

addProductCountStats(int index, Branch.ProductCountStatistic value)

public Branch.Builder addProductCountStats(int index, Branch.ProductCountStatistic value)

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

Parameters
Name Description
index int
value Branch.ProductCountStatistic
Returns
Type Description
Branch.Builder

addProductCountStats(int index, Branch.ProductCountStatistic.Builder builderForValue)

public Branch.Builder addProductCountStats(int index, Branch.ProductCountStatistic.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Branch.ProductCountStatistic.Builder
Returns
Type Description
Branch.Builder

addProductCountStatsBuilder()

public Branch.ProductCountStatistic.Builder addProductCountStatsBuilder()

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
Branch.ProductCountStatistic.Builder

addProductCountStatsBuilder(int index)

public Branch.ProductCountStatistic.Builder addProductCountStatsBuilder(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.Builder

addQualityMetrics(Branch.QualityMetric value)

public Branch.Builder addQualityMetrics(Branch.QualityMetric value)

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
value Branch.QualityMetric
Returns
Type Description
Branch.Builder

addQualityMetrics(Branch.QualityMetric.Builder builderForValue)

public Branch.Builder addQualityMetrics(Branch.QualityMetric.Builder builderForValue)

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
builderForValue Branch.QualityMetric.Builder
Returns
Type Description
Branch.Builder

addQualityMetrics(int index, Branch.QualityMetric value)

public Branch.Builder addQualityMetrics(int index, Branch.QualityMetric value)

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

Parameters
Name Description
index int
value Branch.QualityMetric
Returns
Type Description
Branch.Builder

addQualityMetrics(int index, Branch.QualityMetric.Builder builderForValue)

public Branch.Builder addQualityMetrics(int index, Branch.QualityMetric.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Branch.QualityMetric.Builder
Returns
Type Description
Branch.Builder

addQualityMetricsBuilder()

public Branch.QualityMetric.Builder addQualityMetricsBuilder()

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
Branch.QualityMetric.Builder

addQualityMetricsBuilder(int index)

public Branch.QualityMetric.Builder addQualityMetricsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Branch.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Branch.Builder
Overrides

build()

public Branch build()
Returns
Type Description
Branch

buildPartial()

public Branch buildPartial()
Returns
Type Description
Branch

clear()

public Branch.Builder clear()
Returns
Type Description
Branch.Builder
Overrides

clearDisplayName()

public Branch.Builder clearDisplayName()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Branch.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Branch.Builder
Overrides

clearIsDefault()

public Branch.Builder clearIsDefault()

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

This builder for chaining.

clearLastProductImportTime()

public Branch.Builder clearLastProductImportTime()

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

clearName()

public Branch.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Branch.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Branch.Builder
Overrides

clearProductCountStats()

public Branch.Builder clearProductCountStats()

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

clearQualityMetrics()

public Branch.Builder clearQualityMetrics()

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

clone()

public Branch.Builder clone()
Returns
Type Description
Branch.Builder
Overrides

getDefaultInstanceForType()

public Branch getDefaultInstanceForType()
Returns
Type Description
Branch

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

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

getLastProductImportTimeBuilder()

public Timestamp.Builder getLastProductImportTimeBuilder()

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
Builder

getLastProductImportTimeOrBuilder()

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

getProductCountStatsBuilder(int index)

public Branch.ProductCountStatistic.Builder getProductCountStatsBuilder(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.Builder

getProductCountStatsBuilderList()

public List<Branch.ProductCountStatistic.Builder> getProductCountStatsBuilderList()

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

getProductCountStatsCount()

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

getQualityMetricsBuilder(int index)

public Branch.QualityMetric.Builder getQualityMetricsBuilder(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.Builder

getQualityMetricsBuilderList()

public List<Branch.QualityMetric.Builder> getQualityMetricsBuilderList()

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

getQualityMetricsCount()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Branch other)

public Branch.Builder mergeFrom(Branch other)
Parameter
Name Description
other Branch
Returns
Type Description
Branch.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Branch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Branch.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Branch.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Branch.Builder
Overrides

mergeLastProductImportTime(Timestamp value)

public Branch.Builder mergeLastProductImportTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Branch.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Branch.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Branch.Builder
Overrides

removeProductCountStats(int index)

public Branch.Builder removeProductCountStats(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.Builder

removeQualityMetrics(int index)

public Branch.Builder removeQualityMetrics(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.Builder

setDisplayName(String value)

public Branch.Builder setDisplayName(String value)

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

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

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Branch.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Branch.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Branch.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Branch.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Branch.Builder
Overrides

setIsDefault(boolean value)

public Branch.Builder setIsDefault(boolean value)

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

Parameter
Name Description
value boolean

The isDefault to set.
Returns
Type Description
Branch.Builder

This builder for chaining.

setLastProductImportTime(Timestamp value)

public Branch.Builder setLastProductImportTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Branch.Builder

setLastProductImportTime(Timestamp.Builder builderForValue)

public Branch.Builder setLastProductImportTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Branch.Builder

setName(String value)

public Branch.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Branch.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Branch.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Branch.Builder

This builder for chaining.

setProductCountStats(int index, Branch.ProductCountStatistic value)

public Branch.Builder setProductCountStats(int index, Branch.ProductCountStatistic value)

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

Parameters
Name Description
index int
value Branch.ProductCountStatistic
Returns
Type Description
Branch.Builder

setProductCountStats(int index, Branch.ProductCountStatistic.Builder builderForValue)

public Branch.Builder setProductCountStats(int index, Branch.ProductCountStatistic.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Branch.ProductCountStatistic.Builder
Returns
Type Description
Branch.Builder

setQualityMetrics(int index, Branch.QualityMetric value)

public Branch.Builder setQualityMetrics(int index, Branch.QualityMetric value)

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

Parameters
Name Description
index int
value Branch.QualityMetric
Returns
Type Description
Branch.Builder

setQualityMetrics(int index, Branch.QualityMetric.Builder builderForValue)

public Branch.Builder setQualityMetrics(int index, Branch.QualityMetric.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Branch.QualityMetric.Builder
Returns
Type Description
Branch.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Branch.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Branch.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Branch.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Branch.Builder
Overrides