public static final class Branch.QualityMetric extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
QUALIFIED_PRODUCT_COUNT_FIELD_NUMBER
public static final int QUALIFIED_PRODUCT_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUIREMENT_KEY_FIELD_NUMBER
public static final int REQUIREMENT_KEY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUGGESTED_QUALITY_PERCENT_THRESHOLD_FIELD_NUMBER
public static final int SUGGESTED_QUALITY_PERCENT_THRESHOLD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UNQUALIFIED_PRODUCT_COUNT_FIELD_NUMBER
public static final int UNQUALIFIED_PRODUCT_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UNQUALIFIED_SAMPLE_PRODUCTS_FIELD_NUMBER
public static final int UNQUALIFIED_SAMPLE_PRODUCTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Branch.QualityMetric getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Branch.QualityMetric.Builder newBuilder()
newBuilder(Branch.QualityMetric prototype)
public static Branch.QualityMetric.Builder newBuilder(Branch.QualityMetric prototype)
public static Branch.QualityMetric parseDelimitedFrom(InputStream input)
public static Branch.QualityMetric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Branch.QualityMetric parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Branch.QualityMetric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Branch.QualityMetric parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Branch.QualityMetric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Branch.QualityMetric parseFrom(CodedInputStream input)
public static Branch.QualityMetric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Branch.QualityMetric parseFrom(InputStream input)
public static Branch.QualityMetric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Branch.QualityMetric parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Branch.QualityMetric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Branch.QualityMetric> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Branch.QualityMetric getDefaultInstanceForType()
getParserForType()
public Parser<Branch.QualityMetric> getParserForType()
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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
|
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;
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
|
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> |
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Branch.QualityMetric.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Branch.QualityMetric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Branch.QualityMetric.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
