java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<Branch.QualityMetric.Builder>

com.google.cloud.retail.v2alpha.Branch.QualityMetric.Builder

All Implemented Interfaces:: Branch.QualityMetricOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: Branch.QualityMetric

public static final class Branch.QualityMetric.Builder extends com.google.protobuf.GeneratedMessage.Builder<Branch.QualityMetric.Builder> implements Branch.QualityMetricOrBuilder

 Metric measured on a group of
 [Product][google.cloud.retail.v2alpha.Product]s 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

Method Summary

Modifier and Type

Method

Description

Branch.QualityMetric.Builder

addAllUnqualifiedSampleProducts(Iterable<? extends Product> values)

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

Branch.QualityMetric.Builder

addUnqualifiedSampleProducts(int index, Product value)

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

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.

Branch.QualityMetric.Builder

addUnqualifiedSampleProducts(Product value)

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

Branch.QualityMetric.Builder

addUnqualifiedSampleProducts(Product.Builder builderForValue)

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

Product.Builder

addUnqualifiedSampleProductsBuilder()

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

Product.Builder

addUnqualifiedSampleProductsBuilder(int index)

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

Branch.QualityMetric

build()

Branch.QualityMetric

buildPartial()

Branch.QualityMetric.Builder

clear()

Branch.QualityMetric.Builder

clearQualifiedProductCount()

Number of products passing the quality requirement check.

Branch.QualityMetric.Builder

clearRequirementKey()

The key that represents a quality requirement rule.

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.

Branch.QualityMetric.Builder

clearUnqualifiedProductCount()

Number of products failing the quality requirement check.

Branch.QualityMetric.Builder

clearUnqualifiedSampleProducts()

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

Branch.QualityMetric

getDefaultInstanceForType()

static final com.google.protobuf.Descriptors.Descriptor

getDescriptor()

com.google.protobuf.Descriptors.Descriptor

getDescriptorForType()

int

getQualifiedProductCount()

Number of products passing the quality requirement check.

String

getRequirementKey()

The key that represents a quality requirement rule.

com.google.protobuf.ByteString

getRequirementKeyBytes()

The key that represents a quality requirement rule.

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.

int

getUnqualifiedProductCount()

Number of products failing the quality requirement check.

Product

getUnqualifiedSampleProducts(int index)

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

Product.Builder

getUnqualifiedSampleProductsBuilder(int index)

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

List<Product.Builder>

getUnqualifiedSampleProductsBuilderList()

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

int

getUnqualifiedSampleProductsCount()

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

List<Product>

getUnqualifiedSampleProductsList()

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

ProductOrBuilder

getUnqualifiedSampleProductsOrBuilder(int index)

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

List<? extends ProductOrBuilder>

getUnqualifiedSampleProductsOrBuilderList()

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

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable

internalGetFieldAccessorTable()

final boolean

isInitialized()

Branch.QualityMetric.Builder

mergeFrom(Branch.QualityMetric other)

Branch.QualityMetric.Builder

mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Branch.QualityMetric.Builder

mergeFrom(com.google.protobuf.Message other)

Branch.QualityMetric.Builder

removeUnqualifiedSampleProducts(int index)

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

Branch.QualityMetric.Builder

setQualifiedProductCount(int value)

Number of products passing the quality requirement check.

Branch.QualityMetric.Builder

setRequirementKey(String value)

The key that represents a quality requirement rule.

Branch.QualityMetric.Builder

setRequirementKeyBytes(com.google.protobuf.ByteString value)

The key that represents a quality requirement rule.

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.

Branch.QualityMetric.Builder

setUnqualifiedProductCount(int value)

Number of products failing the quality requirement check.

Branch.QualityMetric.Builder

setUnqualifiedSampleProducts(int index, Product value)

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

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.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Branch.QualityMetric.Builder>
clear

public Branch.QualityMetric.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Branch.QualityMetric.Builder>
getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Branch.QualityMetric.Builder>
getDefaultInstanceForType

public Branch.QualityMetric getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
build

public Branch.QualityMetric build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder
buildPartial

public Branch.QualityMetric buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder
mergeFrom

public Branch.QualityMetric.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Branch.QualityMetric.Builder>
mergeFrom

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

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Branch.QualityMetric.Builder>
mergeFrom

public Branch.QualityMetric.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Branch.QualityMetric.Builder>

Throws:

IOException

getRequirementKey

public String getRequirementKey()

 The key that represents a quality requirement rule.

 Supported keys:
 * "has-valid-uri": product has a valid and accessible
 [uri][google.cloud.retail.v2alpha.Product.uri].

 * "available-expire-time-conformance":
 [Product.available_time][google.cloud.retail.v2alpha.Product.available_time]
 is early than "now", and
 [Product.expire_time][google.cloud.retail.v2alpha.Product.expire_time] is
 greater than "now".

 * "has-searchable-attributes": product has at least one
 [attribute][google.cloud.retail.v2alpha.Product.attributes] set to
 searchable.

 * "has-description": product has non-empty
 [description][google.cloud.retail.v2alpha.Product.description].

 * "has-at-least-bigram-title": Product
 [title][google.cloud.retail.v2alpha.Product.title] has at least two
 words. A comprehensive title helps to improve search quality.

 * "variant-has-image": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 at least one [image][google.cloud.retail.v2alpha.Product.images]. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "variant-has-price-info": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 [price_info][google.cloud.retail.v2alpha.Product.price_info] set. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "has-publish-time": product has non-empty
 [publish_time][google.cloud.retail.v2alpha.Product.publish_time].

string requirement_key = 1;

Specified by:: getRequirementKey in interface Branch.QualityMetricOrBuilder
Returns:: The requirementKey.

getRequirementKeyBytes

public com.google.protobuf.ByteString getRequirementKeyBytes()

 The key that represents a quality requirement rule.

 Supported keys:
 * "has-valid-uri": product has a valid and accessible
 [uri][google.cloud.retail.v2alpha.Product.uri].

 * "available-expire-time-conformance":
 [Product.available_time][google.cloud.retail.v2alpha.Product.available_time]
 is early than "now", and
 [Product.expire_time][google.cloud.retail.v2alpha.Product.expire_time] is
 greater than "now".

 * "has-searchable-attributes": product has at least one
 [attribute][google.cloud.retail.v2alpha.Product.attributes] set to
 searchable.

 * "has-description": product has non-empty
 [description][google.cloud.retail.v2alpha.Product.description].

 * "has-at-least-bigram-title": Product
 [title][google.cloud.retail.v2alpha.Product.title] has at least two
 words. A comprehensive title helps to improve search quality.

 * "variant-has-image": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 at least one [image][google.cloud.retail.v2alpha.Product.images]. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "variant-has-price-info": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 [price_info][google.cloud.retail.v2alpha.Product.price_info] set. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "has-publish-time": product has non-empty
 [publish_time][google.cloud.retail.v2alpha.Product.publish_time].

string requirement_key = 1;

Specified by:: getRequirementKeyBytes in interface Branch.QualityMetricOrBuilder
Returns:: The bytes for requirementKey.

setRequirementKey

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][google.cloud.retail.v2alpha.Product.uri].

 * "available-expire-time-conformance":
 [Product.available_time][google.cloud.retail.v2alpha.Product.available_time]
 is early than "now", and
 [Product.expire_time][google.cloud.retail.v2alpha.Product.expire_time] is
 greater than "now".

 * "has-searchable-attributes": product has at least one
 [attribute][google.cloud.retail.v2alpha.Product.attributes] set to
 searchable.

 * "has-description": product has non-empty
 [description][google.cloud.retail.v2alpha.Product.description].

 * "has-at-least-bigram-title": Product
 [title][google.cloud.retail.v2alpha.Product.title] has at least two
 words. A comprehensive title helps to improve search quality.

 * "variant-has-image": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 at least one [image][google.cloud.retail.v2alpha.Product.images]. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "variant-has-price-info": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 [price_info][google.cloud.retail.v2alpha.Product.price_info] set. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "has-publish-time": product has non-empty
 [publish_time][google.cloud.retail.v2alpha.Product.publish_time].

string requirement_key = 1;

Parameters:: value - The requirementKey to set.
Returns:: 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][google.cloud.retail.v2alpha.Product.uri].

 * "available-expire-time-conformance":
 [Product.available_time][google.cloud.retail.v2alpha.Product.available_time]
 is early than "now", and
 [Product.expire_time][google.cloud.retail.v2alpha.Product.expire_time] is
 greater than "now".

 * "has-searchable-attributes": product has at least one
 [attribute][google.cloud.retail.v2alpha.Product.attributes] set to
 searchable.

 * "has-description": product has non-empty
 [description][google.cloud.retail.v2alpha.Product.description].

 * "has-at-least-bigram-title": Product
 [title][google.cloud.retail.v2alpha.Product.title] has at least two
 words. A comprehensive title helps to improve search quality.

 * "variant-has-image": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 at least one [image][google.cloud.retail.v2alpha.Product.images]. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "variant-has-price-info": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 [price_info][google.cloud.retail.v2alpha.Product.price_info] set. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "has-publish-time": product has non-empty
 [publish_time][google.cloud.retail.v2alpha.Product.publish_time].

string requirement_key = 1;

Returns:: This builder for chaining.

setRequirementKeyBytes

public Branch.QualityMetric.Builder setRequirementKeyBytes(com.google.protobuf.ByteString value)

 The key that represents a quality requirement rule.

 Supported keys:
 * "has-valid-uri": product has a valid and accessible
 [uri][google.cloud.retail.v2alpha.Product.uri].

 * "available-expire-time-conformance":
 [Product.available_time][google.cloud.retail.v2alpha.Product.available_time]
 is early than "now", and
 [Product.expire_time][google.cloud.retail.v2alpha.Product.expire_time] is
 greater than "now".

 * "has-searchable-attributes": product has at least one
 [attribute][google.cloud.retail.v2alpha.Product.attributes] set to
 searchable.

 * "has-description": product has non-empty
 [description][google.cloud.retail.v2alpha.Product.description].

 * "has-at-least-bigram-title": Product
 [title][google.cloud.retail.v2alpha.Product.title] has at least two
 words. A comprehensive title helps to improve search quality.

 * "variant-has-image": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 at least one [image][google.cloud.retail.v2alpha.Product.images]. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "variant-has-price-info": the
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has
 [price_info][google.cloud.retail.v2alpha.Product.price_info] set. You may
 ignore this metric if all your products are at
 [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

 * "has-publish-time": product has non-empty
 [publish_time][google.cloud.retail.v2alpha.Product.publish_time].

string requirement_key = 1;

Parameters:: value - The bytes for requirementKey to set.
Returns:: This builder for chaining.

getQualifiedProductCount

public int getQualifiedProductCount()
```
 Number of products passing the quality requirement check. We only check
 searchable products.
 
```
int32 qualified_product_count = 2;
Specified by:

getQualifiedProductCount in interface Branch.QualityMetricOrBuilder

Returns:

The qualifiedProductCount.
setQualifiedProductCount

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;
Parameters:

value - The qualifiedProductCount to set.

Returns:

This builder for chaining.
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:

This builder for chaining.
getUnqualifiedProductCount

public int getUnqualifiedProductCount()
```
 Number of products failing the quality requirement check. We only check
 searchable products.
 
```
int32 unqualified_product_count = 3;
Specified by:

getUnqualifiedProductCount in interface Branch.QualityMetricOrBuilder

Returns:

The unqualifiedProductCount.
setUnqualifiedProductCount

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;
Parameters:

value - The unqualifiedProductCount to set.

Returns:

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:

This builder for chaining.

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;

Specified by:: getSuggestedQualityPercentThreshold in interface Branch.QualityMetricOrBuilder
Returns:: The suggestedQualityPercentThreshold.

setSuggestedQualityPercentThreshold

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;

Parameters:: value - The suggestedQualityPercentThreshold to set.
Returns:: 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:: This builder for chaining.