Class SearchResponse.Facet.FacetValue.Builder (2.39.0)

public static final class SearchResponse.Facet.FacetValue.Builder extends GeneratedMessageV3.Builder<SearchResponse.Facet.FacetValue.Builder> implements SearchResponse.Facet.FacetValueOrBuilder

A facet value which contains value names and their count.

Protobuf type google.cloud.retail.v2alpha.SearchResponse.Facet.FacetValue

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.Facet.FacetValue.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

build()

public SearchResponse.Facet.FacetValue build()
Returns
TypeDescription
SearchResponse.Facet.FacetValue

buildPartial()

public SearchResponse.Facet.FacetValue buildPartial()
Returns
TypeDescription
SearchResponse.Facet.FacetValue

clear()

public SearchResponse.Facet.FacetValue.Builder clear()
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

clearCount()

public SearchResponse.Facet.FacetValue.Builder clearCount()

Number of items that have this facet value.

int64 count = 3;

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.

clearFacetValue()

public SearchResponse.Facet.FacetValue.Builder clearFacetValue()
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.Facet.FacetValue.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

clearInterval()

public SearchResponse.Facet.FacetValue.Builder clearInterval()

Interval value for a facet, such as [10, 20) for facet "price".

.google.cloud.retail.v2alpha.Interval interval = 2;

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

clearMaxValue()

public SearchResponse.Facet.FacetValue.Builder clearMaxValue()

The maximum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

double max_value = 6;

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.

clearMinValue()

public SearchResponse.Facet.FacetValue.Builder clearMinValue()

The minimum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

double min_value = 5;

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.Facet.FacetValue.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

clearValue()

public SearchResponse.Facet.FacetValue.Builder clearValue()

Text value of a facet, such as "Black" for facet "colorFamilies".

string value = 1;

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.

clone()

public SearchResponse.Facet.FacetValue.Builder clone()
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

getCount()

public long getCount()

Number of items that have this facet value.

int64 count = 3;

Returns
TypeDescription
long

The count.

getDefaultInstanceForType()

public SearchResponse.Facet.FacetValue getDefaultInstanceForType()
Returns
TypeDescription
SearchResponse.Facet.FacetValue

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFacetValueCase()

public SearchResponse.Facet.FacetValue.FacetValueCase getFacetValueCase()
Returns
TypeDescription
SearchResponse.Facet.FacetValue.FacetValueCase

getInterval()

public Interval getInterval()

Interval value for a facet, such as [10, 20) for facet "price".

.google.cloud.retail.v2alpha.Interval interval = 2;

Returns
TypeDescription
Interval

The interval.

getIntervalBuilder()

public Interval.Builder getIntervalBuilder()

Interval value for a facet, such as [10, 20) for facet "price".

.google.cloud.retail.v2alpha.Interval interval = 2;

Returns
TypeDescription
Interval.Builder

getIntervalOrBuilder()

public IntervalOrBuilder getIntervalOrBuilder()

Interval value for a facet, such as [10, 20) for facet "price".

.google.cloud.retail.v2alpha.Interval interval = 2;

Returns
TypeDescription
IntervalOrBuilder

getMaxValue()

public double getMaxValue()

The maximum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

double max_value = 6;

Returns
TypeDescription
double

The maxValue.

getMinValue()

public double getMinValue()

The minimum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

double min_value = 5;

Returns
TypeDescription
double

The minValue.

getValue()

public String getValue()

Text value of a facet, such as "Black" for facet "colorFamilies".

string value = 1;

Returns
TypeDescription
String

The value.

getValueBytes()

public ByteString getValueBytes()

Text value of a facet, such as "Black" for facet "colorFamilies".

string value = 1;

Returns
TypeDescription
ByteString

The bytes for value.

hasInterval()

public boolean hasInterval()

Interval value for a facet, such as [10, 20) for facet "price".

.google.cloud.retail.v2alpha.Interval interval = 2;

Returns
TypeDescription
boolean

Whether the interval field is set.

hasValue()

public boolean hasValue()

Text value of a facet, such as "Black" for facet "colorFamilies".

string value = 1;

Returns
TypeDescription
boolean

Whether the value field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchResponse.Facet.FacetValue other)

public SearchResponse.Facet.FacetValue.Builder mergeFrom(SearchResponse.Facet.FacetValue other)
Parameter
NameDescription
otherSearchResponse.Facet.FacetValue
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResponse.Facet.FacetValue.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchResponse.Facet.FacetValue.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

mergeInterval(Interval value)

public SearchResponse.Facet.FacetValue.Builder mergeInterval(Interval value)

Interval value for a facet, such as [10, 20) for facet "price".

.google.cloud.retail.v2alpha.Interval interval = 2;

Parameter
NameDescription
valueInterval
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Facet.FacetValue.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

setCount(long value)

public SearchResponse.Facet.FacetValue.Builder setCount(long value)

Number of items that have this facet value.

int64 count = 3;

Parameter
NameDescription
valuelong

The count to set.

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.Facet.FacetValue.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

setInterval(Interval value)

public SearchResponse.Facet.FacetValue.Builder setInterval(Interval value)

Interval value for a facet, such as [10, 20) for facet "price".

.google.cloud.retail.v2alpha.Interval interval = 2;

Parameter
NameDescription
valueInterval
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

setInterval(Interval.Builder builderForValue)

public SearchResponse.Facet.FacetValue.Builder setInterval(Interval.Builder builderForValue)

Interval value for a facet, such as [10, 20) for facet "price".

.google.cloud.retail.v2alpha.Interval interval = 2;

Parameter
NameDescription
builderForValueInterval.Builder
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

setMaxValue(double value)

public SearchResponse.Facet.FacetValue.Builder setMaxValue(double value)

The maximum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

double max_value = 6;

Parameter
NameDescription
valuedouble

The maxValue to set.

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.

setMinValue(double value)

public SearchResponse.Facet.FacetValue.Builder setMinValue(double value)

The minimum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

double min_value = 5;

Parameter
NameDescription
valuedouble

The minValue to set.

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.

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

public SearchResponse.Facet.FacetValue.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Facet.FacetValue.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder
Overrides

setValue(String value)

public SearchResponse.Facet.FacetValue.Builder setValue(String value)

Text value of a facet, such as "Black" for facet "colorFamilies".

string value = 1;

Parameter
NameDescription
valueString

The value to set.

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.

setValueBytes(ByteString value)

public SearchResponse.Facet.FacetValue.Builder setValueBytes(ByteString value)

Text value of a facet, such as "Black" for facet "colorFamilies".

string value = 1;

Parameter
NameDescription
valueByteString

The bytes for value to set.

Returns
TypeDescription
SearchResponse.Facet.FacetValue.Builder

This builder for chaining.