Class Branch.QualityMetric.Builder (2.48.0)

Version 2.48.0

• 2.49.0 (latest)
• 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 static final class Branch.QualityMetric.Builder extends GeneratedMessageV3.Builder<Branch.QualityMetric.Builder> implements Branch.QualityMetricOrBuilder

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.

Protobuf type google.cloud.retail.v2alpha.Branch.QualityMetric

Inheritance

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

Implements

Branch.QualityMetricOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllUnqualifiedSampleProducts(Iterable<? extends Product> values)

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

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.retail.v2alpha.Product>

Returns
Type	Description
Branch.QualityMetric.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Branch.QualityMetric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addUnqualifiedSampleProducts(Product value)

public Branch.QualityMetric.Builder addUnqualifiedSampleProducts(Product value)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name	Description
value	Product

Returns
Type	Description
Branch.QualityMetric.Builder

addUnqualifiedSampleProducts(Product.Builder builderForValue)

public Branch.QualityMetric.Builder addUnqualifiedSampleProducts(Product.Builder builderForValue)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name	Description
builderForValue	Product.Builder

Returns
Type	Description
Branch.QualityMetric.Builder

addUnqualifiedSampleProducts(int index, Product value)

public Branch.QualityMetric.Builder addUnqualifiedSampleProducts(int index, Product value)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameters
Name	Description
index	int
value	Product

Returns
Type	Description
Branch.QualityMetric.Builder

addUnqualifiedSampleProducts(int index, Product.Builder builderForValue)

public Branch.QualityMetric.Builder addUnqualifiedSampleProducts(int index, Product.Builder builderForValue)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameters
Name	Description
index	int
builderForValue	Product.Builder

Returns
Type	Description
Branch.QualityMetric.Builder

addUnqualifiedSampleProductsBuilder()

public Product.Builder addUnqualifiedSampleProductsBuilder()

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Returns
Type	Description
Product.Builder

addUnqualifiedSampleProductsBuilder(int index)

public Product.Builder addUnqualifiedSampleProductsBuilder(int index)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Product.Builder

build()

public Branch.QualityMetric build()

Returns
Type	Description
Branch.QualityMetric

buildPartial()

public Branch.QualityMetric buildPartial()

Returns
Type	Description
Branch.QualityMetric

clear()

public Branch.QualityMetric.Builder clear()

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Branch.QualityMetric.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Branch.QualityMetric.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQualifiedProductCount()

public Branch.QualityMetric.Builder clearQualifiedProductCount()

Number of products passing the quality requirement check. We only check searchable products.

int32 qualified_product_count = 2;

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

clearRequirementKey()

public Branch.QualityMetric.Builder clearRequirementKey()

The key that represents a quality requirement rule.

Supported keys:

• "has-valid-uri": product has a valid and accessible uri.

• "available-expire-time-conformance": Product.available_time is early than "now", and Product.expire_time is greater than "now".

• "has-searchable-attributes": product has at least one attribute set to searchable.

• "has-description": product has non-empty description.

• "has-at-least-bigram-title": Product title has at least two words. A comprehensive title helps to improve search quality.

• "variant-has-image": the variant products has at least one image. You may ignore this metric if all your products are at primary level.

• "variant-has-price-info": the variant products has price_info set. You may ignore this metric if all your products are at primary level.

• "has-publish-time": product has non-empty publish_time.

string requirement_key = 1;

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

clearSuggestedQualityPercentThreshold()

public Branch.QualityMetric.Builder clearSuggestedQualityPercentThreshold()

Value from 0 to 100 representing the suggested percentage of products that meet the quality requirements to get good search and recommendation performance. 100 * (qualified_product_count) / (qualified_product_count + unqualified_product_count) should be greater or equal to this suggestion.

double suggested_quality_percent_threshold = 4;

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

clearUnqualifiedProductCount()

public Branch.QualityMetric.Builder clearUnqualifiedProductCount()

Number of products failing the quality requirement check. We only check searchable products.

int32 unqualified_product_count = 3;

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

clearUnqualifiedSampleProducts()

public Branch.QualityMetric.Builder clearUnqualifiedSampleProducts()

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Returns
Type	Description
Branch.QualityMetric.Builder

clone()

public Branch.QualityMetric.Builder clone()

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Branch.QualityMetric getDefaultInstanceForType()

Returns
Type	Description
Branch.QualityMetric

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getQualifiedProductCount()

public int getQualifiedProductCount()

Number of products passing the quality requirement check. We only check searchable products.

int32 qualified_product_count = 2;

Returns
Type	Description
int	The qualifiedProductCount.

getRequirementKey()

public String getRequirementKey()

The key that represents a quality requirement rule.

Supported keys:

• "has-valid-uri": product has a valid and accessible uri.

• "available-expire-time-conformance": Product.available_time is early than "now", and Product.expire_time is greater than "now".

• "has-searchable-attributes": product has at least one attribute set to searchable.

• "has-description": product has non-empty description.

• "has-at-least-bigram-title": Product title has at least two words. A comprehensive title helps to improve search quality.

• "variant-has-image": the variant products has at least one image. You may ignore this metric if all your products are at primary level.

• "variant-has-price-info": the variant products has price_info set. You may ignore this metric if all your products are at primary level.

• "has-publish-time": product has non-empty publish_time.

string requirement_key = 1;

Returns
Type	Description
String	The requirementKey.

getRequirementKeyBytes()

public ByteString getRequirementKeyBytes()

The key that represents a quality requirement rule.

Supported keys:

• "has-valid-uri": product has a valid and accessible uri.

• "available-expire-time-conformance": Product.available_time is early than "now", and Product.expire_time is greater than "now".

• "has-searchable-attributes": product has at least one attribute set to searchable.

• "has-description": product has non-empty description.

• "has-at-least-bigram-title": Product title has at least two words. A comprehensive title helps to improve search quality.

• "variant-has-image": the variant products has at least one image. You may ignore this metric if all your products are at primary level.

• "variant-has-price-info": the variant products has price_info set. You may ignore this metric if all your products are at primary level.

• "has-publish-time": product has non-empty publish_time.

string requirement_key = 1;

Returns
Type	Description
ByteString	The bytes for requirementKey.

getSuggestedQualityPercentThreshold()

public double getSuggestedQualityPercentThreshold()

Value from 0 to 100 representing the suggested percentage of products that meet the quality requirements to get good search and recommendation performance. 100 * (qualified_product_count) / (qualified_product_count + unqualified_product_count) should be greater or equal to this suggestion.

double suggested_quality_percent_threshold = 4;

Returns
Type	Description
double	The suggestedQualityPercentThreshold.

getUnqualifiedProductCount()

public int getUnqualifiedProductCount()

Number of products failing the quality requirement check. We only check searchable products.

int32 unqualified_product_count = 3;

Returns
Type	Description
int	The unqualifiedProductCount.

getUnqualifiedSampleProducts(int index)

public Product getUnqualifiedSampleProducts(int index)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Product

getUnqualifiedSampleProductsBuilder(int index)

public Product.Builder getUnqualifiedSampleProductsBuilder(int index)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Product.Builder

getUnqualifiedSampleProductsBuilderList()

public List<Product.Builder> getUnqualifiedSampleProductsBuilderList()

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Returns
Type	Description
List<Builder>

getUnqualifiedSampleProductsCount()

public int getUnqualifiedSampleProductsCount()

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Returns
Type	Description
int

getUnqualifiedSampleProductsList()

public List<Product> getUnqualifiedSampleProductsList()

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Returns
Type	Description
List<Product>

getUnqualifiedSampleProductsOrBuilder(int index)

public ProductOrBuilder getUnqualifiedSampleProductsOrBuilder(int index)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
ProductOrBuilder

getUnqualifiedSampleProductsOrBuilderList()

public List<? extends ProductOrBuilder> getUnqualifiedSampleProductsOrBuilderList()

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Branch.QualityMetric other)

public Branch.QualityMetric.Builder mergeFrom(Branch.QualityMetric other)

Parameter
Name	Description
other	Branch.QualityMetric

Returns
Type	Description
Branch.QualityMetric.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Branch.QualityMetric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Branch.QualityMetric.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Branch.QualityMetric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeUnqualifiedSampleProducts(int index)

public Branch.QualityMetric.Builder removeUnqualifiedSampleProducts(int index)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Branch.QualityMetric.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Branch.QualityMetric.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setQualifiedProductCount(int value)

public Branch.QualityMetric.Builder setQualifiedProductCount(int value)

Number of products passing the quality requirement check. We only check searchable products.

int32 qualified_product_count = 2;

Parameter
Name	Description
value	int The qualifiedProductCount to set.

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

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

public Branch.QualityMetric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequirementKey(String value)

public Branch.QualityMetric.Builder setRequirementKey(String value)

The key that represents a quality requirement rule.

Supported keys:

• "has-valid-uri": product has a valid and accessible uri.

• "available-expire-time-conformance": Product.available_time is early than "now", and Product.expire_time is greater than "now".

• "has-searchable-attributes": product has at least one attribute set to searchable.

• "has-description": product has non-empty description.

• "has-at-least-bigram-title": Product title has at least two words. A comprehensive title helps to improve search quality.

• "variant-has-image": the variant products has at least one image. You may ignore this metric if all your products are at primary level.

• "variant-has-price-info": the variant products has price_info set. You may ignore this metric if all your products are at primary level.

• "has-publish-time": product has non-empty publish_time.

string requirement_key = 1;

Parameter
Name	Description
value	String The requirementKey to set.

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

setRequirementKeyBytes(ByteString value)

public Branch.QualityMetric.Builder setRequirementKeyBytes(ByteString value)

The key that represents a quality requirement rule.

Supported keys:

• "has-valid-uri": product has a valid and accessible uri.

• "available-expire-time-conformance": Product.available_time is early than "now", and Product.expire_time is greater than "now".

• "has-searchable-attributes": product has at least one attribute set to searchable.

• "has-description": product has non-empty description.

• "has-at-least-bigram-title": Product title has at least two words. A comprehensive title helps to improve search quality.

• "variant-has-image": the variant products has at least one image. You may ignore this metric if all your products are at primary level.

• "variant-has-price-info": the variant products has price_info set. You may ignore this metric if all your products are at primary level.

• "has-publish-time": product has non-empty publish_time.

string requirement_key = 1;

Parameter
Name	Description
value	ByteString The bytes for requirementKey to set.

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

setSuggestedQualityPercentThreshold(double value)

public Branch.QualityMetric.Builder setSuggestedQualityPercentThreshold(double value)

Value from 0 to 100 representing the suggested percentage of products that meet the quality requirements to get good search and recommendation performance. 100 * (qualified_product_count) / (qualified_product_count + unqualified_product_count) should be greater or equal to this suggestion.

double suggested_quality_percent_threshold = 4;

Parameter
Name	Description
value	double The suggestedQualityPercentThreshold to set.

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Branch.QualityMetric.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Branch.QualityMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUnqualifiedProductCount(int value)

public Branch.QualityMetric.Builder setUnqualifiedProductCount(int value)

Number of products failing the quality requirement check. We only check searchable products.

int32 unqualified_product_count = 3;

Parameter
Name	Description
value	int The unqualifiedProductCount to set.

Returns
Type	Description
Branch.QualityMetric.Builder	This builder for chaining.

setUnqualifiedSampleProducts(int index, Product value)

public Branch.QualityMetric.Builder setUnqualifiedSampleProducts(int index, Product value)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameters
Name	Description
index	int
value	Product

Returns
Type	Description
Branch.QualityMetric.Builder

setUnqualifiedSampleProducts(int index, Product.Builder builderForValue)

public Branch.QualityMetric.Builder setUnqualifiedSampleProducts(int index, Product.Builder builderForValue)

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches.

Only the following fields are set in the Product.

• Product.name
• Product.id
• Product.title

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameters
Name	Description
index	int
builderForValue	Product.Builder

Returns
Type	Description
Branch.QualityMetric.Builder