Class Branch.QualityMetric.Builder (2.49.0)

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

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

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

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

getDefaultInstanceForType()

public Branch.QualityMetric getDefaultInstanceForType()
Returns
Type Description
Branch.QualityMetric

getDescriptorForType()

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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

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

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

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